Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • TRecord = any

Hierarchy

  • Cursor

Index

Constructors

constructor

  • new Cursor<TRecord>(connection: Connection, nextCursor?: string, changeCursor?: string, data?: Record<TRecord>[], streamQualifier?: string | { instanceID: string } | { organization: string; project: string; stream: string }, defaultPageSize?: number): Cursor<TRecord>
  • Type parameters

    • TRecord = any

    Parameters

    • connection: Connection
    • Optional nextCursor: string
    • Optional changeCursor: string
    • Optional data: Record<TRecord>[]
    • Optional streamQualifier: string | { instanceID: string } | { organization: string; project: string; stream: string }
    • Optional defaultPageSize: number

    Returns Cursor<TRecord>

Properties

Optional changeCursor

changeCursor: string

Private connection

connection: Connection

Private Optional defaultPageSize

defaultPageSize: number

Private Optional initialData

initialData: Record<TRecord>[]

Optional nextCursor

nextCursor: string

Private Optional streamQualifier

streamQualifier: string | { instanceID: string } | { organization: string; project: string; stream: string }

Methods

hasNext

  • hasNext(): boolean
  • Returns boolean

hasNextChanges

  • hasNextChanges(): boolean
  • Returns boolean

readNext

  • readNext(opts?: ReadOptions): Promise<ReadResult<TRecord>>
  • Parameters

    • Optional opts: ReadOptions

    Returns Promise<ReadResult<TRecord>>

readNextChanges

  • readNextChanges(opts?: ReadOptions): Promise<ReadResult<TRecord>>
  • Parameters

    • Optional opts: ReadOptions

    Returns Promise<ReadResult<TRecord>>

subscribeChanges

  • subscribeChanges(opts: SubscribeOptions<TRecord>): { unsubscribe: () => void }
  • Parameters

    • opts: SubscribeOptions<TRecord>

    Returns { unsubscribe: () => void }

    • unsubscribe: () => void
        • (): void
        • Returns void

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method
  • Property

Generated using TypeDoc