Interface ListOptions

interface ListOptions {
    after?: string;
    keyPattern?: string;
    limit?: number;
}

Properties

after?: string

Only return entires after this key.

Use this to paginate through results, using the key of the last entry in the list call.

keyPattern?: string

Only return entries that match the pattern,

  • %: A percent sign (%) matches any sequence of zero or more characters.
  • _: An underscore (_) matches any single character.

To match _ and % as literals escape them with backslash (\_ and \%).

Example

`user\_%` will match `user_123123`
limit?: number

Number of entries to return, max 100.

Defaults to 25 as of writing.

Generated using TypeDoc