Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DocumentListResponse<TReturn, TNext>

Type parameters

  • TReturn = any

  • TNext = undefined

Hierarchy

Index

Properties

Methods

Properties

Promise

Promise: PromiseConstructor

Readonly [Symbol.toStringTag]

[Symbol.toStringTag]: string

autoPagingEach

autoPagingEach: AutoPagingEach<Document>

autoPagingToArray

autoPagingToArray: AutoPagingToArray<Document>

Methods

[Symbol.asyncIterator]

  • [Symbol.asyncIterator](): AsyncIterableIterator<Document>

catch

  • catch<TResult>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<Document | TResult>

  • Attaches a callback for only the rejection of the Promise.

    Type parameters

    • TResult = never

    Parameters

    • Optional onrejected: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null

      The callback to execute when the Promise is rejected.

    Returns Promise<Document | TResult>

    A Promise for the completion of the callback.

finally

  • Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

    Parameters

    • Optional onfinally: (() => void) | undefined | null

      The callback to execute when the Promise is settled (fulfilled or rejected).

    Returns Promise<Document>

    A Promise for the completion of the callback.

next

  • Parameters

    • Rest ...args: [] | [TNext]

    Returns Promise<IteratorResult<Document, TReturn>>

Optional return

  • return(value?: TReturn | PromiseLike<TReturn>): Promise<IteratorResult<Document, TReturn>>

  • Parameters

    • Optional value: TReturn | PromiseLike<TReturn>

    Returns Promise<IteratorResult<Document, TReturn>>

then

  • then<TResult1, TResult2>(onfulfilled?: ((value: Document) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>

  • Attaches callbacks for the resolution and/or rejection of the Promise.

    Type parameters

    • TResult1 = Document

    • TResult2 = never

    Parameters

    • Optional onfulfilled: ((value: Document) => TResult1 | PromiseLike<TResult1>) | undefined | null

      The callback to execute when the Promise is resolved.

    • Optional onrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null

      The callback to execute when the Promise is rejected.

    Returns Promise<TResult1 | TResult2>

    A Promise for the completion of which ever callback is executed.

Optional throw