Skip to content

TypeScript API / laikacms/assets / ListResourcesOptions

Interface: ListResourcesOptions ​

Properties ​

depth ​

ts
depth: number;

filters? ​

ts
optional filters?: Readonly<Record<string, string>>;

Named filter values, keyed by the wire names declared in getCapabilities().filtering.filters (e.g. { search: 'logo' }). Implementations MUST fail with InvalidData on undeclared names rather than silently ignore them — a filtered listing must never be quietly unfiltered.


hints? ​

ts
optional hints?: FetchHints;

pagination ​

ts
pagination: 
  | {
  page: number;
  perPage?: number;
}
  | {
  before?: string;
  perPage?: number;
}
  | {
  after?: string;
  perPage?: number;
}
  | {
  limit?: number;
  offset: number;
};

Released under the MIT License.