GridFSBucketWriteStream

A writable stream that enables you to write buffers to GridFS.

Do not instantiate this class directly. Use openUploadStream() instead.

Hierarchy

Writable
- GridFSBucketWriteStream

Index

Constructors

constructor

Events

Constructors

constructor

new GridFSBucketWriteStream(bucket: GridFSBucket, filename: string, options?: GridFSBucketWriteStreamOptions): GridFSBucketWriteStream

Overrides Writable.constructor
- Defined in src/gridfs/upload.ts:70
internal

Parameters
- bucket: GridFSBucket
  
  Handle for this stream's corresponding bucket
- filename: string
  
  The value of the 'filename' key in the files doc
- Optional options: GridFSBucketWriteStreamOptions
  
  Optional settings.
Returns GridFSBucketWriteStream

Events

Static Readonly CLOSE

CLOSE: "close" = 'close'

Static Readonly ERROR

ERROR: "error" = 'error'

Static Readonly FINISH

FINISH: "finish" = 'finish'

end() was called and the write stream successfully wrote the file metadata and all the chunks to MongoDB.

Properties

bucket

bucket: GridFSBucket

bufToStore

bufToStore: Buffer

chunkSizeBytes

chunkSizeBytes: number

chunks

chunks: Collection<GridFSChunk>

destroyed

destroyed: boolean

done

done: boolean

filename

filename: string

files

files: Collection<GridFSFile>

id

id: ObjectId

length

length: number

n

n: number

options

options: GridFSBucketWriteStreamOptions

pos

pos: number

state

state: { aborted: boolean; errored: boolean; outstandingRequests: number; streamEnd: boolean }

Type declaration

aborted: boolean
errored: boolean
outstandingRequests: number
streamEnd: boolean

Readonly writable

writable: boolean

Readonly writableCorked

writableCorked: number

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

Optional writeConcern

writeConcern: WriteConcern

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

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.

Methods

Optional _construct

_construct(callback: (error?: null | Error) => void): void

Inherited from Writable._construct
- Defined in node_modules/@types/node/stream.d.ts:154
Parameters
- callback: (error?: null | Error) => void
  - - (error?: null | Error): void
    - Parameters
      - Optional error: null | Error
      Returns void
Returns void

_destroy

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

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

_final

_final(callback: (error?: null | Error) => void): void

Inherited from Writable._final
- Defined in node_modules/@types/node/stream.d.ts:156
Parameters
- callback: (error?: null | Error) => void
  - - (error?: null | Error): void
    - Parameters
      - Optional error: null | Error
      Returns void
Returns void

_write

_write(chunk: any, encoding: BufferEncoding, callback: (error?: null | Error) => void): void

Inherited from Writable._write
- Defined in node_modules/@types/node/stream.d.ts:152
Parameters
- chunk: any
- encoding: BufferEncoding
- callback: (error?: null | Error) => void
  - - (error?: null | Error): void
    - Parameters
      - Optional error: null | Error
      Returns void
Returns void

Optional _writev

_writev(chunks: { chunk: any; encoding: BufferEncoding }[], callback: (error?: null | Error) => void): void

Inherited from Writable._writev
- Defined in node_modules/@types/node/stream.d.ts:153
Parameters
- chunks: { chunk: any; encoding: BufferEncoding }[]
- callback: (error?: null | Error) => void
  - - (error?: null | Error): void
    - Parameters
      - Optional error: null | Error
      Returns void
Returns void

abort

abort(): Promise<void>
abort(callback: Callback<void>): void

- Defined in src/gridfs/upload.ts:142
Places this write stream into an aborted state (all future writes fail) and deletes all chunks that have already been written.

Returns Promise<void>
- Defined in src/gridfs/upload.ts:143
Parameters
- callback: Callback<void>
Returns void

addListener

addListener(event: "close", listener: () => void): GridFSBucketWriteStream
addListener(event: "drain", listener: () => void): GridFSBucketWriteStream
addListener(event: "error", listener: (err: Error) => void): GridFSBucketWriteStream
addListener(event: "finish", listener: () => void): GridFSBucketWriteStream
addListener(event: "pipe", listener: (src: Readable) => void): GridFSBucketWriteStream
addListener(event: "unpipe", listener: (src: Readable) => void): GridFSBucketWriteStream
addListener(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketWriteStream

Inherited from Writable.addListener
- Defined in node_modules/@types/node/stream.d.ts:177
Event emitter The defined events on documents including:
1. close
2. drain
3. error
4. finish
5. pipe
6. unpipe
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.addListener
- Defined in node_modules/@types/node/stream.d.ts:178
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.addListener
- Defined in node_modules/@types/node/stream.d.ts:179
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.addListener
- Defined in node_modules/@types/node/stream.d.ts:180
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.addListener
- Defined in node_modules/@types/node/stream.d.ts:181
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.addListener
- Defined in node_modules/@types/node/stream.d.ts:182
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.addListener
- Defined in node_modules/@types/node/stream.d.ts:183
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketWriteStream

cork

cork(): void

Inherited from Writable.cork
- Defined in node_modules/@types/node/stream.d.ts:163
Returns void

destroy

destroy(error?: Error): void

Inherited from Writable.destroy
- Defined in node_modules/@types/node/stream.d.ts:165
Parameters
- Optional error: Error
Returns void

emit

emit(event: "close"): boolean
emit(event: "drain"): boolean
emit(event: "error", err: Error): boolean
emit(event: "finish"): boolean
emit(event: "pipe", src: Readable): boolean
emit(event: "unpipe", src: Readable): boolean
emit(event: string | symbol, ...args: any[]): boolean

Inherited from Writable.emit
- Defined in node_modules/@types/node/stream.d.ts:185
Parameters
- event: "close"
Returns boolean
Inherited from Writable.emit
- Defined in node_modules/@types/node/stream.d.ts:186
Parameters
- event: "drain"
Returns boolean
Inherited from Writable.emit
- Defined in node_modules/@types/node/stream.d.ts:187
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Writable.emit
- Defined in node_modules/@types/node/stream.d.ts:188
Parameters
- event: "finish"
Returns boolean
Inherited from Writable.emit
- Defined in node_modules/@types/node/stream.d.ts:189
Parameters
- event: "pipe"
- src: Readable
Returns boolean
Inherited from Writable.emit
- Defined in node_modules/@types/node/stream.d.ts:190
Parameters
- event: "unpipe"
- src: Readable
Returns boolean
Inherited from Writable.emit
- Defined in node_modules/@types/node/stream.d.ts:191
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

end

end(): void
end(chunk: Buffer): void
end(callback: Callback<void | GridFSFile>): void
end(chunk: Buffer, callback: Callback<void | GridFSFile>): void
end(chunk: Buffer, encoding: BufferEncoding): void
end(chunk: Buffer, encoding: undefined | BufferEncoding, callback: Callback<void | GridFSFile>): void

Overrides Writable.end
- Defined in src/gridfs/upload.ts:176
Tells the stream that no more data will be coming in. The stream will persist the remaining data to MongoDB, write the files document, and then emit a 'finish' event.

Returns void
Overrides Writable.end
- Defined in src/gridfs/upload.ts:177
Parameters
- chunk: Buffer
Returns void
Overrides Writable.end
- Defined in src/gridfs/upload.ts:178
Parameters
- callback: Callback<void | GridFSFile>
Returns void
Overrides Writable.end
- Defined in src/gridfs/upload.ts:179
Parameters
- chunk: Buffer
- callback: Callback<void | GridFSFile>
Returns void
Overrides Writable.end
- Defined in src/gridfs/upload.ts:180
Parameters
- chunk: Buffer
- encoding: BufferEncoding
Returns void
Overrides Writable.end
- Defined in src/gridfs/upload.ts:181
Parameters
- chunk: Buffer
- encoding: undefined | BufferEncoding
- callback: Callback<void | GridFSFile>
Returns void

eventNames

eventNames(): (string | symbol)[]

Inherited from Writable.eventNames
- Defined in node_modules/@types/node/events.d.ts:87
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from Writable.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:79
Returns number

listenerCount

listenerCount(event: string | symbol): number

Inherited from Writable.listenerCount
- Defined in node_modules/@types/node/events.d.ts:83
Parameters
- event: string | symbol
Returns number

listeners

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

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

off

off(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketWriteStream

Inherited from Writable.off
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketWriteStream

on

on(event: "close", listener: () => void): GridFSBucketWriteStream
on(event: "drain", listener: () => void): GridFSBucketWriteStream
on(event: "error", listener: (err: Error) => void): GridFSBucketWriteStream
on(event: "finish", listener: () => void): GridFSBucketWriteStream
on(event: "pipe", listener: (src: Readable) => void): GridFSBucketWriteStream
on(event: "unpipe", listener: (src: Readable) => void): GridFSBucketWriteStream
on(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketWriteStream

Inherited from Writable.on
- Defined in node_modules/@types/node/stream.d.ts:193
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.on
- Defined in node_modules/@types/node/stream.d.ts:194
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.on
- Defined in node_modules/@types/node/stream.d.ts:195
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.on
- Defined in node_modules/@types/node/stream.d.ts:196
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.on
- Defined in node_modules/@types/node/stream.d.ts:197
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.on
- Defined in node_modules/@types/node/stream.d.ts:198
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.on
- Defined in node_modules/@types/node/stream.d.ts:199
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketWriteStream

once

once(event: "close", listener: () => void): GridFSBucketWriteStream
once(event: "drain", listener: () => void): GridFSBucketWriteStream
once(event: "error", listener: (err: Error) => void): GridFSBucketWriteStream
once(event: "finish", listener: () => void): GridFSBucketWriteStream
once(event: "pipe", listener: (src: Readable) => void): GridFSBucketWriteStream
once(event: "unpipe", listener: (src: Readable) => void): GridFSBucketWriteStream
once(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketWriteStream

Inherited from Writable.once
- Defined in node_modules/@types/node/stream.d.ts:201
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.once
- Defined in node_modules/@types/node/stream.d.ts:202
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.once
- Defined in node_modules/@types/node/stream.d.ts:203
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.once
- Defined in node_modules/@types/node/stream.d.ts:204
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.once
- Defined in node_modules/@types/node/stream.d.ts:205
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.once
- Defined in node_modules/@types/node/stream.d.ts:206
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.once
- Defined in node_modules/@types/node/stream.d.ts:207
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketWriteStream

pipe

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

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

prependListener

prependListener(event: "close", listener: () => void): GridFSBucketWriteStream
prependListener(event: "drain", listener: () => void): GridFSBucketWriteStream
prependListener(event: "error", listener: (err: Error) => void): GridFSBucketWriteStream
prependListener(event: "finish", listener: () => void): GridFSBucketWriteStream
prependListener(event: "pipe", listener: (src: Readable) => void): GridFSBucketWriteStream
prependListener(event: "unpipe", listener: (src: Readable) => void): GridFSBucketWriteStream
prependListener(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketWriteStream

Inherited from Writable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:209
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:210
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:211
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:212
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:213
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:214
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:215
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketWriteStream

prependOnceListener

prependOnceListener(event: "close", listener: () => void): GridFSBucketWriteStream
prependOnceListener(event: "drain", listener: () => void): GridFSBucketWriteStream
prependOnceListener(event: "error", listener: (err: Error) => void): GridFSBucketWriteStream
prependOnceListener(event: "finish", listener: () => void): GridFSBucketWriteStream
prependOnceListener(event: "pipe", listener: (src: Readable) => void): GridFSBucketWriteStream
prependOnceListener(event: "unpipe", listener: (src: Readable) => void): GridFSBucketWriteStream
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketWriteStream

Inherited from Writable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:217
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:218
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:219
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:220
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:221
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:222
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:223
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketWriteStream

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): GridFSBucketWriteStream

Inherited from Writable.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:77
Parameters
- Optional event: string | symbol
Returns GridFSBucketWriteStream

removeListener

removeListener(event: "close", listener: () => void): GridFSBucketWriteStream
removeListener(event: "drain", listener: () => void): GridFSBucketWriteStream
removeListener(event: "error", listener: (err: Error) => void): GridFSBucketWriteStream
removeListener(event: "finish", listener: () => void): GridFSBucketWriteStream
removeListener(event: "pipe", listener: (src: Readable) => void): GridFSBucketWriteStream
removeListener(event: "unpipe", listener: (src: Readable) => void): GridFSBucketWriteStream
removeListener(event: string | symbol, listener: (...args: any[]) => void): GridFSBucketWriteStream

Inherited from Writable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:225
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:226
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:227
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:228
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:229
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:230
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns GridFSBucketWriteStream
Inherited from Writable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:231
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns GridFSBucketWriteStream

setDefaultEncoding

setDefaultEncoding(encoding: BufferEncoding): GridFSBucketWriteStream

Inherited from Writable.setDefaultEncoding
- Defined in node_modules/@types/node/stream.d.ts:159
Parameters
- encoding: BufferEncoding
Returns GridFSBucketWriteStream

setMaxListeners

setMaxListeners(n: number): GridFSBucketWriteStream

Inherited from Writable.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:78
Parameters
- n: number
Returns GridFSBucketWriteStream

uncork

uncork(): void

Inherited from Writable.uncork
- Defined in node_modules/@types/node/stream.d.ts:164
Returns void

write

write(chunk: Buffer): boolean
write(chunk: Buffer, callback: Callback<void>): boolean
write(chunk: Buffer, encoding: undefined | BufferEncoding): boolean
write(chunk: Buffer, encoding: undefined | BufferEncoding, callback: Callback<void>): boolean

Overrides Writable.write
- Defined in src/gridfs/upload.ts:122
Write a buffer to the stream.

Parameters
- chunk: Buffer
  
  Buffer to write
Returns boolean

False if this write required flushing a chunk to MongoDB. True otherwise.
Overrides Writable.write
- Defined in src/gridfs/upload.ts:123
Parameters
- chunk: Buffer
- callback: Callback<void>
Returns boolean
Overrides Writable.write
- Defined in src/gridfs/upload.ts:124
Parameters
- chunk: Buffer
- encoding: undefined | BufferEncoding
Returns boolean
Overrides Writable.write
- Defined in src/gridfs/upload.ts:125
Parameters
- chunk: Buffer
- encoding: undefined | BufferEncoding
- callback: Callback<void>
Returns boolean

Static getEventListener

getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

Inherited from Writable.getEventListener
- Defined in node_modules/@types/node/events.d.ts:34
Returns a list listener for a specific emitter event name.

Parameters
- emitter: DOMEventTarget | EventEmitter
- name: string | symbol
Returns Function[]

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from Writable.listenerCount
- Defined in node_modules/@types/node/events.d.ts:30
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

Inherited from Writable.on
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: EventEmitter
- event: string
- Optional options: StaticEventEmitterOptions
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>

Inherited from Writable.once
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- emitter: NodeEventTarget
- event: string | symbol
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>
Inherited from Writable.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: DOMEventTarget
- event: string
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>

Hierarchy

Index

Constructors

Events

Properties

Methods

Constructors

constructor

Parameters

bucket: GridFSBucket

filename: string

Optional options: GridFSBucketWriteStreamOptions

Returns GridFSBucketWriteStream

Events

Static Readonly CLOSE

Static Readonly ERROR

Static Readonly FINISH

Properties

bucket

bufToStore

chunkSizeBytes

chunks

destroyed

done

filename

files

id

length

n

options

pos

state

Type declaration

aborted: boolean

errored: boolean

outstandingRequests: number

streamEnd: boolean

Readonly writable

Readonly writableCorked

Readonly writableEnded

Readonly writableFinished

Readonly writableHighWaterMark

Readonly writableLength

Readonly writableObjectMode

Optional writeConcern

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

Optional _construct

Parameters

callback: (error?: null | Error) => void

Parameters

Optional error: null | Error

Returns void

Returns void

_destroy

Parameters

error: null | Error

callback: (error?: null | Error) => void

Parameters

Optional error: null | Error

Returns void

Returns void

_final

Parameters

callback: (error?: null | Error) => void

Parameters

Optional error: null | Error

Returns void

Returns void

_write

Parameters

chunk: any

encoding: BufferEncoding

callback: (error?: null | Error) => void

Parameters

Optional error: null | Error

Returns void