SlpFolderStream | @vinceau/slp-realtime

SlpFolderStream is responsible for monitoring a folder, and detecting when a new SLP file is created and is written to. This creates essentially a fake live-stream by reading the SLP file as it's still being written to.

Typically when you detect changes to a file that is still being written to, you want to include a timeout where if the file isn't changed within that timeout, you consider it "done" and stop checking it. However, since players can pause Slippi games for an indefinite amount of time, we don't want to timeout since the file might still continue to be written to. So to achieve this, we use the package tailstream where we have to manually call done() when we no longer anticipate the file to change.

Hierarchy

RxSlpStream
- SlpFolderStream

Implements

WritableStream

Index

Constructors

constructor

Properties

Constructors

constructor

new SlpFolderStream(options?: Partial<SlpFileWriterOptions>, opts?: WritableOptions): SlpFolderStream

Overrides RxSlpStream.constructor
- Defined in src/stream/slpFolderStream.ts:31
Parameters
- Optional options: Partial<SlpFileWriterOptions>
- Optional opts: WritableOptions
Returns SlpFolderStream

Properties

destroyed

destroyed: boolean

gameEnd$

gameEnd$: Observable<GameEndType> = fromEvent<GameEndType>(this.parser, SlpParserEvent.END).pipe(share())

gameStart$

gameStart$: Observable<GameStartType> = fromEvent<GameStartType>(this.parser, SlpParserEvent.SETTINGS).pipe(share())

messageSize$

messageSize$: Observable<Map<Command, number>> = this.messageSizeSource.asObservable()

Protected parser

parser: SlpParser = new SlpParser({ strict: true })

playerFrame$

playerFrame$: Observable<FrameEntryType> = fromEvent<FrameEntryType>(this.parser, SlpParserEvent.FINALIZED_FRAME).pipe(share())

writable

writable: boolean

writableEnded

writableEnded: boolean

writableFinished

writableFinished: boolean

writableHighWaterMark

writableHighWaterMark: number

writableLength

writableLength: number

writableObjectMode

writableObjectMode: boolean

Static defaultMaxListeners

defaultMaxListeners: number

Methods

_destroy

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

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

_final

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

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

_write

_write(newData: Buffer, encoding: string, callback: (error?: Error | null, data?: any) => void): void

Inherited from RxSlpStream._write

Overrides Writable._write
- Defined in node_modules/@slippi/slippi-js/dist/utils/slpStream.d.ts:50
Parameters
- newData: Buffer
- encoding: string
- callback: (error?: Error | null, data?: any) => void
  - - (error?: Error | null, data?: any): void
    - Parameters
      - Optional error: Error | null
      - Optional data: any
      Returns void
Returns void

Optional _writev

_writev(chunks: Array<{ chunk: any; encoding: string }>, callback: (error?: Error | null) => void): void

Inherited from DolphinOutput._writev
- Defined in node_modules/@types/node/stream.d.ts:129
Parameters
- chunks: Array<{ chunk: any; encoding: string }>
- callback: (error?: Error | null) => void
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

addListener

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

Inherited from DolphinOutput.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:152
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 this
Inherited from DolphinOutput.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:153
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:154
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from DolphinOutput.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:155
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:156
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from DolphinOutput.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:157
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from DolphinOutput.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:158
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

cork

cork(): void

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

destroy

destroy(error?: Error): void

Inherited from DolphinOutput.destroy
- Defined in node_modules/@types/node/stream.d.ts:140
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 DolphinOutput.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:160
Parameters
- event: "close"
Returns boolean
Inherited from DolphinOutput.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:161
Parameters
- event: "drain"
Returns boolean
Inherited from DolphinOutput.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:162
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from DolphinOutput.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:163
Parameters
- event: "finish"
Returns boolean
Inherited from DolphinOutput.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:164
Parameters
- event: "pipe"
- src: Readable
Returns boolean
Inherited from DolphinOutput.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:165
Parameters
- event: "unpipe"
- src: Readable
Returns boolean
Inherited from DolphinOutput.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:166
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

end

end(cb?: () => void): void
end(chunk: any, cb?: () => void): void
end(chunk: any, encoding: string, cb?: () => void): void

Inherited from DolphinOutput.end
- Defined in node_modules/@types/node/stream.d.ts:135
Parameters
- Optional cb: () => void
  - - (): void
    - Returns void
Returns void
Inherited from DolphinOutput.end
- Defined in node_modules/@types/node/stream.d.ts:136
Parameters
- chunk: any
- Optional cb: () => void
  - - (): void
    - Returns void
Returns void
Inherited from DolphinOutput.end
- Defined in node_modules/@types/node/stream.d.ts:137
Parameters
- chunk: any
- encoding: string
- Optional cb: () => void
  - - (): void
    - Returns void
Returns void

endCurrentFile

endCurrentFile(): void

Inherited from RxSlpStream.endCurrentFile
- Defined in node_modules/@slippi/slippi-js/dist/utils/slpFileWriter.d.ts:48
Ends the current file being written to.

memberof

SlpFileWriter

Returns void

eventNames

eventNames(): Array<string | symbol>

Inherited from DolphinOutput.eventNames
- Defined in node_modules/@types/node/events.d.ts:33
Returns Array<string | symbol>

getCurrentFilename

getCurrentFilename(): string | null

Inherited from RxSlpStream.getCurrentFilename
- Defined in node_modules/@slippi/slippi-js/dist/utils/slpFileWriter.d.ts:41
Return the name of the SLP file currently being written or null if no file is being written to currently.

memberof

SlpFileWriter

Returns string | null

getMaxListeners

getMaxListeners(): number

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

latestFile

latestFile(): string | null

- Defined in src/stream/slpFolderStream.ts:110
Returns the latest created file that was found by folder monitoring.

Returns string | null

listenerCount

listenerCount(type: string | symbol): number

Inherited from DolphinOutput.listenerCount
- Defined in node_modules/@types/node/events.d.ts:34
Parameters
- type: string | symbol
Returns number

listeners

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

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

off

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

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

on

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

Inherited from DolphinOutput.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:168
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:169
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:170
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from DolphinOutput.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:171
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:172
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from DolphinOutput.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:173
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from DolphinOutput.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:174
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

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

Inherited from DolphinOutput.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:176
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:177
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:178
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from DolphinOutput.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:179
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:180
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from DolphinOutput.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:181
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from DolphinOutput.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:182
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

pipe

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

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

prependListener

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

Inherited from DolphinOutput.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:184
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:185
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:186
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from DolphinOutput.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:187
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:188
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from DolphinOutput.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:189
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from DolphinOutput.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:190
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

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

Inherited from DolphinOutput.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:192
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:193
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:194
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from DolphinOutput.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:195
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:196
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from DolphinOutput.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:197
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from DolphinOutput.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:198
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from DolphinOutput.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from DolphinOutput.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:200
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:201
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:202
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from DolphinOutput.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:203
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from DolphinOutput.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:204
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from DolphinOutput.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:205
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from DolphinOutput.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:206
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

restart

restart(): void

Inherited from RxSlpStream.restart

Overrides SlpStream.restart
- Defined in src/stream/rxSlpStream.ts:69
Returns void

setDefaultEncoding

setDefaultEncoding(encoding: string): this

Inherited from DolphinOutput.setDefaultEncoding
- Defined in node_modules/@types/node/stream.d.ts:134
Parameters
- encoding: string
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from DolphinOutput.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- n: number
Returns this

start

start(slpFolder: string, includeSubfolders?: boolean): void

- Defined in src/stream/slpFolderStream.ts:97
Starts watching a particular folder for slp files. It treats all new .slp files as though it's a live Slippi stream.

memberof

SlpFolderStream

Parameters
- slpFolder: string
- Optional includeSubfolders: boolean
Returns void

stop

stop(): void

- Defined in src/stream/slpFolderStream.ts:102
Returns void

uncork

uncork(): void

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

updateSettings

updateSettings(settings: Partial<SlpFileWriterOptions>): void

Inherited from RxSlpStream.updateSettings
- Defined in node_modules/@slippi/slippi-js/dist/utils/slpFileWriter.d.ts:55
Updates the settings to be the desired ones passed in.

memberof

SlpFileWriter

Parameters
- settings: Partial<SlpFileWriterOptions>
Returns void

write

write(chunk: any, cb?: (error: Error | null | undefined) => void): boolean
write(chunk: any, encoding: string, cb?: (error: Error | null | undefined) => void): boolean

Inherited from DolphinOutput.write
- Defined in node_modules/@types/node/stream.d.ts:132
Parameters
- chunk: any
- Optional cb: (error: Error | null | undefined) => void
  - - (error: Error | null | undefined): void
    - Parameters
      - error: Error | null | undefined
      Returns void
Returns boolean
Inherited from DolphinOutput.write
- Defined in node_modules/@types/node/stream.d.ts:133
Parameters
- chunk: any
- encoding: string
- Optional cb: (error: Error | null | undefined) => void
  - - (error: Error | null | undefined): void
    - Parameters
      - error: Error | null | undefined
      Returns void
Returns boolean

Static listenerCount

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

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

since v4.0.0

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

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: Partial<SlpFileWriterOptions>

Optional opts: WritableOptions

Returns SlpFolderStream

Properties

destroyed

gameEnd$

gameStart$

messageSize$

Protected parser

playerFrame$

writable

writableEnded

writableFinished

writableHighWaterMark

writableLength

writableObjectMode

Static defaultMaxListeners

Methods

_destroy

Parameters

error: Error | null

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

Parameters

Optional error: Error | null

Returns void

Returns void

_final

Parameters

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

Parameters

Optional error: Error | null

Returns void

Returns void

_write

Parameters

newData: Buffer

encoding: string

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

Parameters

Optional error: Error | null

Optional data: any

Returns void

Returns void

Optional _writev

Parameters

chunks: Array<{ chunk: any; encoding: string }>

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

Parameters

Optional error: Error | null

Returns void

Returns void

addListener

Parameters

event: "close"

listener: () => void

Returns void

Returns this

Parameters

event: "drain"

listener: () => void

Returns void

Returns this

Parameters

event: "error"

listener: (err: Error) => void

Parameters

err: Error

Returns void

Returns this

Parameters

event: "finish"