Interface DiscoverPageOptions

Options for the discoverPage() function.

Example

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

interface DiscoverPageOptions {
    includeHidden?: boolean;
    interactiveOnly?: boolean;
    limit?: number;
    offset?: number;
    timeout?: number;
}

Index

Properties

includeHidden? interactiveOnly? limit? offset? timeout?

Properties

`Optional` `Readonly`includeHidden

includeHidden?: boolean

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

`Optional` `Readonly`interactiveOnly

interactiveOnly?: boolean

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

`Optional` `Readonly`limit

limit?: number

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

`Optional` `Readonly`offset

offset?: number

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

`Optional` `Readonly`timeout

timeout?: number

Discovery timeout in milliseconds. Default: 30_000.

Interface DiscoverPageOptions

Example

Index

Properties

Properties

`Optional` `Readonly`includeHidden

`Optional` `Readonly`interactiveOnly

`Optional` `Readonly`limit

`Optional` `Readonly`offset

`Optional` `Readonly`timeout

Settings

On This Page

Interface DiscoverPageOptions

Example

Index

Properties

Properties

Optional ReadonlyincludeHidden

Optional ReadonlyinteractiveOnly

Optional Readonlylimit

Optional Readonlyoffset

Optional Readonlytimeout

Settings

On This Page

`Optional` `Readonly`includeHidden

`Optional` `Readonly`interactiveOnly

`Optional` `Readonly`limit

`Optional` `Readonly`offset

`Optional` `Readonly`timeout