Interface ApiListPromise<T>

Readonly[toStringTag]

[asyncIterator]

• "[asyncIterator]"(): AsyncIterableIterator<T, any, any>

  Returns AsyncIterableIterator<T, any, any>

catch

• catch<TResult = never>(
      onrejected?: (reason: any) => TResult | PromiseLike<TResult>,
  ): Promise<PageResult<T> | TResult>

  Attaches a callback for only the rejection of the Promise.

  Type Parameters

  • TResult = never

  Parameters

  • Optionalonrejected: (reason: any) => TResult | PromiseLike<TResult>

    The callback to execute when the Promise is rejected.

  Returns Promise<PageResult<T> | TResult>

  A Promise for the completion of the callback.

finally

• finally(onfinally?: () => void): Promise<PageResult<T>>

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

  Parameters

  • Optionalonfinally: () => void

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

  Returns Promise<PageResult<T>>

  A Promise for the completion of the callback.

next

• next(...__namedParameters: [] | [any]): Promise<IteratorResult<T, any>>

  Parameters

  • ...__namedParameters: [] | [any]

  Returns Promise<IteratorResult<T, any>>

Optionalreturn

• return?(value?: any): Promise<IteratorResult<T, any>>

  Parameters

  • Optionalvalue: any

  Returns Promise<IteratorResult<T, any>>

then

• then<TResult1 = PageResult<T>, TResult2 = never>(
      onfulfilled?: (value: PageResult) => TResult1 | PromiseLike<TResult1>,
      onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>,
  ): Promise<TResult1 | TResult2>

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

  Type Parameters

  • TResult1 = PageResult<T>
  • TResult2 = never

  Parameters

  • Optionalonfulfilled: (value: PageResult) => TResult1 | PromiseLike<TResult1>

    The callback to execute when the Promise is resolved.

  • Optionalonrejected: (reason: any) => TResult2 | PromiseLike<TResult2>

    The callback to execute when the Promise is rejected.

  Returns Promise<TResult1 | TResult2>

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

Optionalthrow

• throw?(e?: any): Promise<IteratorResult<T, any>>

  Parameters

  • Optionale: any

  Returns Promise<IteratorResult<T, any>>