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?: {
defaultFields?: API_FIELDS | string;
props?: Pick<BaseProps,
"fields">;
}
) => stringParameters
| Name | Required | Type | Description |
|---|---|---|---|
options | Optional | { defaultFields?: API_FIELDS | string; props?: Pick<BaseProps, "fields">; } |
Referenced Types
Examples
const props = { fields: 'BASIC' };
const fields = createRequestFields({ props });
console.log(fields) // prints `BASIC`