Global

Methods

init(optionsnon-null) → {QueryManager}

Initialize the IPC query library. Call this ASAP from the application code.
Multiple calls return the same instance of QueryManager
Parameters:
Name Type Description
options IPCOptions
Returns:
Type
QueryManager
Example
import { init } from "ipc";
 // returns a QueryManager instance
const queryManager = init({
   accountId: "XXXX",
   ctCatsToPreload: [],
   domain: "www.example.com",
});

init(optionsnon-null) → {QueryManager}

Initialize the IPC query library. Call this ASAP from the application code.
Multiple calls return the same instance of QueryManager
Parameters:
Name Type Description
options IPCOptions
Returns:
Type
QueryManager
Example
import { init } from "ipc";
 // returns a QueryManager instance
const queryManager = init({
   accountId: "XXXX",
   ctCatsToPreload: [],
   domain: "www.example.com",
});

Type Definitions

IPCOptions

Type:
  • object
Properties:
Name Type Description
accountId string IPC account ID
ctCatsToPreload Array.<string> UUIDs of CT categories to preload
domain string Domain of client

IPCOptions

Type:
  • object
Properties:
Name Type Description
accountId string IPC account ID
ctCatsToPreload Array.<string> UUIDs of CT categories to preload
domain string Domain of client

ProductQueryParams

Type:
  • object
Properties:
Name Type Description
sort ProductQueryParamsSort sorting parameters
pagination ProductQueryParamsPagination pagination parameters
filters Array.<number> selected valueIds for filtering

ProductQueryParamsPagination

Type:
  • object
Properties:
Name Type Description
offset number page offset
limit number page limit

ProductQueryParamsSort

Type:
  • object
Properties:
Name Type Description
attributeId number Id of selected attribute
order number 0 for ASCENDING, 1 for DESCENDING