Class ChangesResultItemStream

Hierarchy (view full)

Stream<ChangesResultItem>
- ChangesResultItemStream

Index

Constructors

Methods

_transform getValidationError push read

Constructors

constructor

new ChangesResultItemStream(opts?): ChangesResultItemStream
Parameters
- Optional opts: TransformOptions
Returns ChangesResultItemStream
Inherited from Stream.constructor
- Defined in cloudant/features/stream.ts:20

Methods

_transform

_transform(chunk, encoding, callback): void
Parameters
- chunk: ChangesResult
- encoding: BufferEncoding
- callback: TransformCallback
Returns void
Overrides Stream._transform
- Defined in cloudant/features/changesResultItemStream.ts:23

`Private` getValidationError

getValidationError(params): Error
Parameters
- params: any
Returns Error
- Defined in cloudant/features/changesResultItemStream.ts:39

push

push(chunk, encoding?): boolean
Parameters
- chunk: ChangesResultItem
- Optional encoding: BufferEncoding
Returns boolean
Inherited from Stream.push
- Defined in cloudant/features/stream.ts:28

read

read(size?): ChangesResultItem
Parameters
- Optional size: number
Returns ChangesResultItem
Inherited from Stream.read
- Defined in cloudant/features/stream.ts:32

Generated using TypeDoc