You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
createRequestFields
Helper used in API methods, responsible for building the fields query param sent to SAP Commerce Cloud.
By default, the helper returns 'FULL' if no props or defaultFields are passed.
Signature
createRequestFields: (
options?: {
props?: Pick<BaseProps,
"fields">;
defaultFields?: API_FIELDS | string;
}
) => stringParameters
| Name | Required | Type | Description |
|---|---|---|---|
options | Optional | { props?: Pick<BaseProps, "fields">; defaultFields?: API_FIELDS | string; } |
Referenced Types
Examples
const props = { fields: 'BASIC' };
const fields = createRequestFields({ props });
console.log(fields) // prints `BASIC`