Interface GetOptions

interface GetOptions {
    project?: string[];
    timeout?: number;
    transcoder?: Transcoder;
    withExpiry?: boolean;
}

Properties

project? timeout? transcoder? withExpiry?

Properties

Optional project

project?: string[]

Specifies a list of fields within the document which should be fetched. This allows for easy retrieval of select fields without incurring the overhead of fetching the whole document.

Optional timeout

timeout?: number

The timeout for this operation, represented in milliseconds.

Optional transcoder

transcoder?: Transcoder

Specifies an explicit transcoder to use for this specific operation.

Optional withExpiry

withExpiry?: boolean

Indicates that the expiry of the document should be fetched alongside the data itself.

Settings

Member Visibility

Theme

On This Page

projecttimeouttranscoderwithExpiry