Cursor | Documentation

Type Parameters

DocType = any
Options = never

Hierarchy

<internal>.Readable
- Cursor

Methods

Static once

once(emitter: <internal>.NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: <internal>.DOMEventTarget, event: string): Promise<any[]>

Inherited from Readable.once
- Defined in node_modules/@types/node/events.d.ts:13
Parameters
- emitter: <internal>.NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from Readable.once
- Defined in node_modules/@types/node/events.d.ts:14
Parameters
- emitter: <internal>.DOMEventTarget
- event: string
Returns Promise<any[]>

Static on

on(emitter: <internal>.EventEmitter, event: string): <internal>.AsyncIterableIterator<any>

Inherited from Readable.on
- Defined in node_modules/@types/node/events.d.ts:15
Parameters
- emitter: <internal>.EventEmitter
- event: string
Returns <internal>.AsyncIterableIterator<any>

Static listenerCount

listenerCount(emitter: <internal>.EventEmitter, event: string | symbol): number

Inherited from Readable.listenerCount
- Defined in node_modules/@types/node/events.d.ts:18
deprecated
since v4.0.0

Parameters
- emitter: <internal>.EventEmitter
- event: string | symbol
Returns number

off

off(event: string | symbol, listener: ((...args: any[]) => void)): Cursor<DocType, Options>

Inherited from Readable.off
- Defined in node_modules/@types/node/globals.d.ts:734
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Cursor<DocType, Options>

removeAllListeners

removeAllListeners(event?: string | symbol): Cursor<DocType, Options>

Inherited from Readable.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:735
Parameters
- Optional event: string | symbol
Returns Cursor<DocType, Options>

setMaxListeners

setMaxListeners(n: number): Cursor<DocType, Options>

Inherited from Readable.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:736
Parameters
- n: number
Returns Cursor<DocType, Options>

getMaxListeners

getMaxListeners(): number

Inherited from Readable.getMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:737
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from Readable.listeners
- Defined in node_modules/@types/node/globals.d.ts:738
Parameters
- event: string | symbol
Returns Function[]

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from Readable.rawListeners
- Defined in node_modules/@types/node/globals.d.ts:739
Parameters
- event: string | symbol
Returns Function[]

listenerCount

listenerCount(type: string | symbol): number

Inherited from Readable.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:741
Parameters
- type: string | symbol
Returns number

eventNames

eventNames(): (string | symbol)[]

Inherited from Readable.eventNames
- Defined in node_modules/@types/node/globals.d.ts:745
Returns (string | symbol)[]

pipe

pipe<T>(destination: T, options?: { end?: boolean }): T

Inherited from Readable.pipe
- Defined in node_modules/@types/node/stream.d.ts:5
Type Parameters
- T extends <internal>.WritableStream<T>
Parameters
- destination: T
- Optional options: { end?: boolean }
  - Optional end?: boolean
Returns T

Static from

from(iterable: <internal>.Iterable<any> | <internal>.AsyncIterable<any>, options?: <internal>.ReadableOptions): <internal>.Readable

Inherited from Readable.from
- Defined in node_modules/@types/node/stream.d.ts:24
A utility method for creating Readable Streams out of iterators.

Parameters
- iterable: <internal>.Iterable<any> | <internal>.AsyncIterable<any>
- Optional options: <internal>.ReadableOptions
Returns <internal>.Readable

_read

_read(size: number): void

Inherited from Readable._read
- Defined in node_modules/@types/node/stream.d.ts:35
Parameters
- size: number
Returns void

read

read(size?: number): any

Inherited from Readable.read
- Defined in node_modules/@types/node/stream.d.ts:36
Parameters
- Optional size: number
Returns any

setEncoding

setEncoding(encoding: string): Cursor<DocType, Options>

Inherited from Readable.setEncoding
- Defined in node_modules/@types/node/stream.d.ts:37
Parameters
- encoding: string
Returns Cursor<DocType, Options>

pause

pause(): Cursor<DocType, Options>

Inherited from Readable.pause
- Defined in node_modules/@types/node/stream.d.ts:38
Returns Cursor<DocType, Options>

resume

resume(): Cursor<DocType, Options>

Inherited from Readable.resume
- Defined in node_modules/@types/node/stream.d.ts:39
Returns Cursor<DocType, Options>

isPaused

isPaused(): boolean

Inherited from Readable.isPaused
- Defined in node_modules/@types/node/stream.d.ts:40
Returns boolean

unpipe

unpipe(destination?: <internal>.WritableStream): Cursor<DocType, Options>

Inherited from Readable.unpipe
- Defined in node_modules/@types/node/stream.d.ts:41
Parameters
- Optional destination: <internal>.WritableStream
Returns Cursor<DocType, Options>

unshift

unshift(chunk: any, encoding?: <internal>.BufferEncoding): void

Inherited from Readable.unshift
- Defined in node_modules/@types/node/stream.d.ts:42
Parameters
- chunk: any
- Optional encoding: <internal>.BufferEncoding
Returns void

wrap

wrap(oldStream: <internal>.ReadableStream): Cursor<DocType, Options>

Inherited from Readable.wrap
- Defined in node_modules/@types/node/stream.d.ts:43
Parameters
- oldStream: <internal>.ReadableStream
Returns Cursor<DocType, Options>

push

push(chunk: any, encoding?: string): boolean

Inherited from Readable.push
- Defined in node_modules/@types/node/stream.d.ts:44
Parameters
- chunk: any
- Optional encoding: string
Returns boolean

_destroy

_destroy(error: Error, callback: ((error?: Error) => void)): void

Inherited from Readable._destroy
- Defined in node_modules/@types/node/stream.d.ts:45
Parameters
- error: Error
- callback: ((error?: Error) => void)
  - - (error?: Error): void
    - Parameters
      - Optional error: Error
      Returns void
Returns void

destroy

destroy(error?: Error): Cursor<DocType, Options>

Inherited from Readable.destroy
- Defined in node_modules/@types/node/stream.d.ts:46
Parameters
- Optional error: Error
Returns Cursor<DocType, Options>

addListener

addListener(event: "close", listener: (() => void)): Cursor<DocType, Options>
addListener(event: "data", listener: ((chunk: any) => void)): Cursor<DocType, Options>
addListener(event: "end", listener: (() => void)): Cursor<DocType, Options>
addListener(event: "readable", listener: (() => void)): Cursor<DocType, Options>
addListener(event: "error", listener: ((err: Error) => void)): Cursor<DocType, Options>
addListener(event: string | symbol, listener: ((...args: any[]) => void)): Cursor<DocType, Options>

Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:57
Event emitter The defined events on documents including:
1. close
2. data
3. end
4. readable
5. error
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:58
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:59
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:60
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:61
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:62
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Cursor<DocType, Options>

emit

emit(event: "close"): boolean
emit(event: "data", chunk: any): boolean
emit(event: "end"): boolean
emit(event: "readable"): boolean
emit(event: "error", err: Error): boolean
emit(event: string | symbol, ...args: any[]): boolean

Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:64
Parameters
- event: "close"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:65
Parameters
- event: "data"
- chunk: any
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:66
Parameters
- event: "end"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:67
Parameters
- event: "readable"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:68
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:69
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

on

on(event: "close", listener: (() => void)): Cursor<DocType, Options>
on(event: "data", listener: ((chunk: any) => void)): Cursor<DocType, Options>
on(event: "end", listener: (() => void)): Cursor<DocType, Options>
on(event: "readable", listener: (() => void)): Cursor<DocType, Options>
on(event: "error", listener: ((err: Error) => void)): Cursor<DocType, Options>
on(event: string | symbol, listener: ((...args: any[]) => void)): Cursor<DocType, Options>

Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:71
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:72
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:73
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:74
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:75
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:76
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Cursor<DocType, Options>

once

once(event: "close", listener: (() => void)): Cursor<DocType, Options>
once(event: "data", listener: ((chunk: any) => void)): Cursor<DocType, Options>
once(event: "end", listener: (() => void)): Cursor<DocType, Options>
once(event: "readable", listener: (() => void)): Cursor<DocType, Options>
once(event: "error", listener: ((err: Error) => void)): Cursor<DocType, Options>
once(event: string | symbol, listener: ((...args: any[]) => void)): Cursor<DocType, Options>

Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:78
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:79
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:80
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:81
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:82
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:83
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Cursor<DocType, Options>

prependListener

prependListener(event: "close", listener: (() => void)): Cursor<DocType, Options>
prependListener(event: "data", listener: ((chunk: any) => void)): Cursor<DocType, Options>
prependListener(event: "end", listener: (() => void)): Cursor<DocType, Options>
prependListener(event: "readable", listener: (() => void)): Cursor<DocType, Options>
prependListener(event: "error", listener: ((err: Error) => void)): Cursor<DocType, Options>
prependListener(event: string | symbol, listener: ((...args: any[]) => void)): Cursor<DocType, Options>

Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:85
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:86
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:87
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:88
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:89
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:90
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Cursor<DocType, Options>

prependOnceListener

prependOnceListener(event: "close", listener: (() => void)): Cursor<DocType, Options>
prependOnceListener(event: "data", listener: ((chunk: any) => void)): Cursor<DocType, Options>
prependOnceListener(event: "end", listener: (() => void)): Cursor<DocType, Options>
prependOnceListener(event: "readable", listener: (() => void)): Cursor<DocType, Options>
prependOnceListener(event: "error", listener: ((err: Error) => void)): Cursor<DocType, Options>
prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): Cursor<DocType, Options>

Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:92
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:93
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:94
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:95
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:96
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:97
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Cursor<DocType, Options>

removeListener

removeListener(event: "close", listener: (() => void)): Cursor<DocType, Options>
removeListener(event: "data", listener: ((chunk: any) => void)): Cursor<DocType, Options>
removeListener(event: "end", listener: (() => void)): Cursor<DocType, Options>
removeListener(event: "readable", listener: (() => void)): Cursor<DocType, Options>
removeListener(event: "error", listener: ((err: Error) => void)): Cursor<DocType, Options>
removeListener(event: string | symbol, listener: ((...args: any[]) => void)): Cursor<DocType, Options>

Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:99
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:100
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:101
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:102
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:103
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Cursor<DocType, Options>
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:104
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Cursor<DocType, Options>

[asyncIterator]

[asyncIterator](): <internal>.AsyncIterableIterator<DocType>

Overrides Readable.[asyncIterator]
- Defined in node_modules/mongoose/types/cursor.d.ts:14
Returns <internal>.AsyncIterableIterator<DocType>

addCursorFlag

addCursorFlag(flag: CursorFlag, value: boolean): Cursor<DocType, Options>

- Defined in node_modules/mongoose/types/cursor.d.ts:20
Adds a cursor flag. Useful for setting the noCursorTimeout and tailable flags.

Parameters
- flag: CursorFlag
- value: boolean
Returns Cursor<DocType, Options>

close

close(callback: CallbackWithoutResult): void
close(): Promise<void>

- Defined in node_modules/mongoose/types/cursor.d.ts:26
Marks this cursor as closed. Will stop streaming and subsequent calls to next() will error.

Parameters
- callback: CallbackWithoutResult
Returns void
- Defined in node_modules/mongoose/types/cursor.d.ts:27
Returns Promise<void>

rewind

rewind(): Cursor<DocType, Options>

- Defined in node_modules/mongoose/types/cursor.d.ts:34
Rewind this cursor to its uninitialized state. Any options that are present on the cursor will remain in effect. Iterating this cursor will cause new queries to be sent to the server, even if the resultant data has already been retrieved by this cursor.

Returns Cursor<DocType, Options>

eachAsync

eachAsync(fn: ((doc: DocType[]) => any), options: EachAsyncOptions & { batchSize: number }, callback: CallbackWithoutResult): void
eachAsync(fn: ((doc: DocType) => any), options: EachAsyncOptions, callback: CallbackWithoutResult): void
eachAsync(fn: ((doc: DocType[]) => any), options: EachAsyncOptions & { batchSize: number }): Promise<void>
eachAsync(fn: ((doc: DocType) => any), options?: EachAsyncOptions): Promise<void>

- Defined in node_modules/mongoose/types/cursor.d.ts:42
Execute fn for every document(s) in the cursor. If batchSize is provided fn will be executed for each batch of documents. If fn returns a promise, will wait for the promise to resolve before iterating on to the next one. Returns a promise that resolves when done.

Parameters
- fn: ((doc: DocType[]) => any)
  - - (doc: DocType[]): any
    - Parameters
      - doc: DocType[]
      Returns any
- options: EachAsyncOptions & { batchSize: number }
- callback: CallbackWithoutResult
Returns void
- Defined in node_modules/mongoose/types/cursor.d.ts:43
Parameters
- fn: ((doc: DocType) => any)
  - - (doc: DocType): any
    - Parameters
      - doc: DocType
      Returns any
- options: EachAsyncOptions
- callback: CallbackWithoutResult
Returns void
- Defined in node_modules/mongoose/types/cursor.d.ts:44
Parameters
- fn: ((doc: DocType[]) => any)
  - - (doc: DocType[]): any
    - Parameters
      - doc: DocType[]
      Returns any
- options: EachAsyncOptions & { batchSize: number }
Returns Promise<void>
- Defined in node_modules/mongoose/types/cursor.d.ts:45
Parameters
- fn: ((doc: DocType) => any)
  - - (doc: DocType): any
    - Parameters
      - doc: DocType
      Returns any
- Optional options: EachAsyncOptions
Returns Promise<void>

map

map<ResultType>(fn: ((res: DocType) => ResultType)): Cursor<ResultType, Options>

- Defined in node_modules/mongoose/types/cursor.d.ts:51
Registers a transform function which subsequently maps documents retrieved via the streams interface or .next()

Type Parameters
- ResultType
Parameters
- fn: ((res: DocType) => ResultType)
  - - (res: DocType): ResultType
    - Parameters
      - res: DocType
      Returns ResultType
Returns Cursor<ResultType, Options>

next(callback: <internal>.Callback<DocType>): void
next(): Promise<DocType>

- Defined in node_modules/mongoose/types/cursor.d.ts:57
Get the next document from this cursor. Will return null when there are no documents left.

Parameters
- callback: <internal>.Callback<DocType>
Returns void
- Defined in node_modules/mongoose/types/cursor.d.ts:58
Returns Promise<DocType>

Properties

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

readable

readable: boolean

Readonly readableEncoding

readableEncoding: <internal>.BufferEncoding

Readonly readableEnded

readableEnded: boolean

Readonly readableFlowing

readableFlowing: boolean

Readonly readableHighWaterMark

readableHighWaterMark: number

Readonly readableLength

readableLength: number

Readonly readableObjectMode

readableObjectMode: boolean

destroyed

destroyed: boolean

options

options: Options

Constructors

constructor

new Cursor<DocType, Options>(opts?: <internal>.ReadableOptions): Cursor<DocType, Options>

Inherited from Readable.constructor
- Defined in node_modules/@types/node/stream.d.ts:34
Type Parameters
- DocType = any
- Options = never
Parameters
- Optional opts: <internal>.ReadableOptions
Returns Cursor<DocType, Options>

Type Parameters

DocType = any

Options = never

Hierarchy

Index

Methods

Properties

Constructors

Methods

Static once

Parameters

emitter: <internal>.NodeEventTarget

event: string | symbol

Returns Promise<any[]>

Parameters

emitter: <internal>.DOMEventTarget

event: string

Returns Promise<any[]>

Static on

Parameters

emitter: <internal>.EventEmitter

event: string

Returns <internal>.AsyncIterableIterator<any>

Static listenerCount

Parameters

emitter: <internal>.EventEmitter

event: string | symbol

Returns number

off

Parameters

event: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns Cursor<DocType, Options>

removeAllListeners

Parameters

Optional event: string | symbol

Returns Cursor<DocType, Options>

setMaxListeners

Parameters

n: number

Returns Cursor<DocType, Options>

getMaxListeners

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

rawListeners

Parameters

event: string | symbol

Returns Function[]

listenerCount

Parameters

type: string | symbol

Returns number

eventNames

Returns (string | symbol)[]

pipe

Type Parameters

T extends <internal>.WritableStream<T>

Parameters

destination: T

Optional options: { end?: boolean }

Optional end?: boolean

Returns T

Static from

Parameters

iterable: <internal>.Iterable<any> | <internal>.AsyncIterable<any>

Optional options: <internal>.ReadableOptions

Returns <internal>.Readable

_read

Parameters

size: number

Returns void

read

Parameters

Optional size: number