Skip to main content
Version: 1.x

Interface: DiscoverPageOptions

Options for the discoverPage() function.

Example​

const opts: DiscoverPageOptions = {
  interactiveOnly: true,
  includeHidden: false,
  limit: 50,
  offset: 0,
};

Properties​

includeHidden?​

readonly optional includeHidden?: boolean

When true, hidden controls are included. Default: false.

interactiveOnly?​

readonly optional interactiveOnly?: boolean

When true, only interactive controls are returned. Default: false.

limit?​

readonly optional limit?: number

Maximum number of controls to return (applied after filtering).

offset?​

readonly optional offset?: number

Number of controls to skip before returning results (applied after filtering).

timeout?​

readonly optional timeout?: number

Discovery timeout in milliseconds. Default: 30_000.