lightning/ui*Api Wire Adapters and Functions

Wire adapters and JavaScript functions in these modules are built on top of Lightning Data Service (LDS) and User Interface API. Use these wire adapters and functions to work with Salesforce data and metadata.

The Syntax sections in the following topics use TypeScript formatting. We use this formatting to make the API syntax easier to understand. For example, functions may be described by the function name, parameter name and type, and a return type like this.

Optional parameters are appended with ? like objectInfo?: ObjectInfo. For more information, see the TypeScript Handbook.

Other sections beside the Syntax sections are written in JavaScript. Lightning web components do not support TypeScript. You must write your code in JavaScript.

For information about how LDS and User Interface API work, see Lightning Data Service.

See Also