Options
All
  • Public
  • Public/Protected
  • All
Menu

Options used when querying resources.

Hierarchy

  • QueryOptions

Index

Properties

after: { createdAt?: string; updatedAt?: string }

Usually derived from a URL like '/messages?after[updatedAt]=2021-01-01T00:00:00.000Z'.

Type declaration

  • Optional createdAt?: string
  • Optional updatedAt?: string
before: { createdAt?: string; updatedAt?: string }

Usually derived from a URL like '/messages?before[updatedAt]=2021-01-01T00:00:00.000Z'.

Type declaration

  • Optional createdAt?: string
  • Optional updatedAt?: string
limit: number

Usually derived from a URL like '/messages?limit=100'.

default

100

orderBy: "createdAt" | "updatedAt"

You should limit this to indexed property keys.

Usually derived from a URL like '/messages?orderBy=updatedAt'.

default

updatedAt

orderDirection: "desc" | "asc"

Usually derived from a URL like '/messages?orderDirection=updatedAt'.

default

desc

Generated using TypeDoc