Interface: AppiumServerSocket

@appium/types.AppiumServerSocket

Hierarchy

Socket

↳ AppiumServerSocket

Properties

_openReqCount

• _openReqCount: number

Defined in

node_modules/@appium/types/lib/server.ts:51

allowHalfOpen

• allowHalfOpen: boolean

If false then the stream will automatically end the writable side when the readable side ends. Set initially by the allowHalfOpen constructor option, which defaults to true.

This can be changed manually to change the half-open behavior of an existingDuplex stream instance, but must be changed before the 'end' event is emitted.

Since

v0.9.4

Inherited from

Socket.allowHalfOpen

Defined in

node_modules/@types/node/stream.d.ts:1028

bufferSize

• Readonly bufferSize: number

This property shows the number of characters buffered for writing. The buffer may contain strings whose length after encoding is not yet known. So this number is only an approximation of the number of bytes in the buffer.

net.Socket has the property that socket.write() always works. This is to help users get up and running quickly. The computer cannot always keep up with the amount of data that is written to a socket. The network connection simply might be too slow. Node.js will internally queue up the data written to a socket and send it out over the wire when it is possible.

The consequence of this internal buffering is that memory may grow. Users who experience large or growing bufferSize should attempt to "throttle" the data flows in their program with socket.pause() and socket.resume().

Since

v0.3.8

Deprecated

Since v14.6.0 - Use writableLength instead.

Inherited from

Socket.bufferSize

Defined in

node_modules/@types/node/net.d.ts:250

bytesRead

• Readonly bytesRead: number

The amount of received bytes.

Since

v0.5.3

Inherited from

Socket.bytesRead

Defined in

node_modules/@types/node/net.d.ts:255

bytesWritten

• Readonly bytesWritten: number

The amount of bytes sent.

Since

v0.5.3

Inherited from

Socket.bytesWritten

Defined in

node_modules/@types/node/net.d.ts:260

closed

• Readonly closed: boolean

Inherited from

Socket.closed

Defined in

node_modules/@types/node/stream.d.ts:1017

connecting

• Readonly connecting: boolean

If true,socket.connect(options[, connectListener]) was called and has not yet finished. It will stay true until the socket becomes connected, then it is set to false and the 'connect' event is emitted. Note that the socket.connect(options[, connectListener]) callback is a listener for the 'connect' event.

Since

v6.1.0

Inherited from

Socket.connecting

Defined in

node_modules/@types/node/net.d.ts:268

destroyed

• Readonly destroyed: boolean

See writable.destroyed for further details.

Inherited from

Socket.destroyed

Defined in

node_modules/@types/node/net.d.ts:278

errored

• Readonly errored: null | Error

Inherited from

Socket.errored

Defined in

node_modules/@types/node/stream.d.ts:1018

localAddress

• Optional Readonly localAddress: string

The string representation of the local IP address the remote client is connecting on. For example, in a server listening on '0.0.0.0', if a client connects on '192.168.1.1', the value of socket.localAddress would be'192.168.1.1'.

Since

v0.9.6

Inherited from

Socket.localAddress

Defined in

node_modules/@types/node/net.d.ts:285

localFamily

• Optional Readonly localFamily: string

The string representation of the local IP family. 'IPv4' or 'IPv6'.

Since

v18.8.0, v16.18.0

Inherited from

Socket.localFamily

Defined in

node_modules/@types/node/net.d.ts:295

localPort

• Optional Readonly localPort: number

The numeric representation of the local port. For example, 80 or 21.

Since

v0.9.6

Inherited from

Socket.localPort

Defined in

node_modules/@types/node/net.d.ts:290

pending

• Readonly pending: boolean

This is true if the socket is not connected yet, either because .connect()has not yet been called or because it is still in the process of connecting (see socket.connecting).

Since

v11.2.0, v10.16.0

Inherited from

Socket.pending

Defined in

node_modules/@types/node/net.d.ts:274

readable

• readable: boolean

Is true if it is safe to call readable.read(), which means the stream has not been destroyed or emitted 'error' or 'end'.

Since

v11.4.0

Inherited from

Socket.readable

Defined in

node_modules/@types/node/stream.d.ts:67

readableAborted

• Readonly readableAborted: boolean

Returns whether the stream was destroyed or errored before emitting 'end'.

Since

v16.8.0

Inherited from

Socket.readableAborted

Defined in

node_modules/@types/node/stream.d.ts:61

readableDidRead

• Readonly readableDidRead: boolean

Returns whether 'data' has been emitted.

Since

v16.7.0, v14.18.0

Inherited from

Socket.readableDidRead

Defined in

node_modules/@types/node/stream.d.ts:73

readableEncoding

• Readonly readableEncoding: null | BufferEncoding

Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

Since

v12.7.0

Inherited from

Socket.readableEncoding

Defined in

node_modules/@types/node/stream.d.ts:78

readableEnded

• Readonly readableEnded: boolean

Becomes true when 'end' event is emitted.

Since

v12.9.0

Inherited from

Socket.readableEnded

Defined in

node_modules/@types/node/stream.d.ts:83

readableFlowing

• Readonly readableFlowing: null | boolean

This property reflects the current state of a Readable stream as described in the Three states section.

Since

v9.4.0

Inherited from

Socket.readableFlowing

Defined in

node_modules/@types/node/stream.d.ts:89

readableHighWaterMark

• Readonly readableHighWaterMark: number

Returns the value of highWaterMark passed when creating this Readable.

Since

v9.3.0

Inherited from

Socket.readableHighWaterMark

Defined in

node_modules/@types/node/stream.d.ts:94

readableLength

• Readonly readableLength: number

This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the highWaterMark.

Since

v9.4.0

Inherited from

Socket.readableLength

Defined in

node_modules/@types/node/stream.d.ts:101

readableObjectMode

• Readonly readableObjectMode: boolean

Getter for the property objectMode of a given Readable stream.

Since

v12.3.0

Inherited from

Socket.readableObjectMode

Defined in

node_modules/@types/node/stream.d.ts:106

readyState

• Readonly readyState: SocketReadyState

This property represents the state of the connection as a string.

If the stream is connecting socket.readyState is opening.
If the stream is readable and writable, it is open.
If the stream is readable and not writable, it is readOnly.
If the stream is not readable and writable, it is writeOnly.

Since

v0.5.0

Inherited from

Socket.readyState

Defined in

node_modules/@types/node/net.d.ts:305

remoteAddress

• Optional Readonly remoteAddress: string

The string representation of the remote IP address. For example,'74.125.127.100' or '2001:4860:a005::68'. Value may be undefined if the socket is destroyed (for example, if the client disconnected).

Since

v0.5.10

Inherited from

Socket.remoteAddress

Defined in

node_modules/@types/node/net.d.ts:311

remoteFamily

• Optional Readonly remoteFamily: string

The string representation of the remote IP family. 'IPv4' or 'IPv6'. Value may be undefined if the socket is destroyed (for example, if the client disconnected).

Since

v0.11.14

Inherited from

Socket.remoteFamily

Defined in

node_modules/@types/node/net.d.ts:317

remotePort

• Optional Readonly remotePort: number

The numeric representation of the remote port. For example, 80 or 21. Value may be undefined if the socket is destroyed (for example, if the client disconnected).

Since

v0.5.10

Inherited from

Socket.remotePort

Defined in

node_modules/@types/node/net.d.ts:323

timeout

• Optional Readonly timeout: number

The socket timeout in milliseconds as set by socket.setTimeout(). It is undefined if a timeout has not been set.

Since

v10.7.0

Inherited from

Socket.timeout

Defined in

node_modules/@types/node/net.d.ts:329

writable

• Readonly writable: boolean

Inherited from

Socket.writable

Defined in

node_modules/@types/node/stream.d.ts:1009

writableCorked

• Readonly writableCorked: number

Inherited from

Socket.writableCorked

Defined in

node_modules/@types/node/stream.d.ts:1015

writableEnded

• Readonly writableEnded: boolean

Inherited from

Socket.writableEnded

Defined in

node_modules/@types/node/stream.d.ts:1010

writableFinished

• Readonly writableFinished: boolean

Inherited from

Socket.writableFinished

Defined in

node_modules/@types/node/stream.d.ts:1011

writableHighWaterMark

• Readonly writableHighWaterMark: number

Inherited from

Socket.writableHighWaterMark

Defined in

node_modules/@types/node/stream.d.ts:1012

writableLength

• Readonly writableLength: number

Inherited from

Socket.writableLength

Defined in

node_modules/@types/node/stream.d.ts:1013

writableNeedDrain

• Readonly writableNeedDrain: boolean

Inherited from

Socket.writableNeedDrain

Defined in

node_modules/@types/node/stream.d.ts:1016

writableObjectMode

• Readonly writableObjectMode: boolean

Inherited from

Socket.writableObjectMode

Defined in

node_modules/@types/node/stream.d.ts:1014

Methods

[asyncDispose]

▸ [asyncDispose](): Promise<void>

Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

Since

v20.4.0

Returns

Promise<void>

Inherited from

Socket.__@asyncDispose@35045

Defined in

node_modules/@types/node/stream.d.ts:622

[asyncIterator]

▸ [asyncIterator](): AsyncIterableIterator<any>

Returns

AsyncIterableIterator<any>

Inherited from

Socket.__@asyncIterator@35123

Defined in

node_modules/@types/node/stream.d.ts:617

_construct

▸ Optional _construct(callback): void

Parameters

Name	Type
`callback`	(`error?`: `null` \| `Error`) => `void`

Returns

void

Inherited from

Socket._construct

Defined in

node_modules/@types/node/stream.d.ts:123

_destroy

▸ _destroy(error, callback): void

Parameters

Name	Type
`error`	`null` \| `Error`
`callback`	(`error`: `null` \| `Error`) => `void`

Returns

void

Inherited from

Socket._destroy

Defined in

node_modules/@types/node/stream.d.ts:1060

_final

▸ _final(callback): void

Parameters

Name	Type
`callback`	(`error?`: `null` \| `Error`) => `void`

Returns

void

Inherited from

Socket._final

Defined in

node_modules/@types/node/stream.d.ts:1061

_read

▸ _read(size): void

Parameters

Name	Type
`size`	`number`

Returns

void

Inherited from

Socket._read

Defined in

node_modules/@types/node/stream.d.ts:124

_write

▸ _write(chunk, encoding, callback): void

Parameters

Name	Type
`chunk`	`any`
`encoding`	`BufferEncoding`
`callback`	(`error?`: `null` \| `Error`) => `void`

Returns

void

Inherited from

Socket._write

Defined in

node_modules/@types/node/stream.d.ts:1052

_writev

▸ Optional _writev(chunks, callback): void

Parameters

Name	Type
`chunks`	{ `chunk`: `any` ; `encoding`: `BufferEncoding` }[]
`callback`	(`error?`: `null` \| `Error`) => `void`

Returns

void

Inherited from

Socket._writev

Defined in

node_modules/@types/node/stream.d.ts:1053

addListener

▸ addListener(event, listener): AppiumServerSocket

events.EventEmitter 1. close 2. connect 3. data 4. drain 5. end 6. error 7. lookup 8. ready 9. timeout

Parameters

Name	Type
`event`	`string`
`listener`	(...`args`: `any`[]) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.addListener

Defined in

node_modules/@types/node/net.d.ts:355

▸ addListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"close"`
`listener`	(`hadError`: `boolean`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.addListener

Defined in

node_modules/@types/node/net.d.ts:356

▸ addListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"connect"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.addListener

Defined in

node_modules/@types/node/net.d.ts:357

▸ addListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"data"`
`listener`	(`data`: `Buffer`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.addListener

Defined in

node_modules/@types/node/net.d.ts:358

▸ addListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"drain"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.addListener

Defined in

node_modules/@types/node/net.d.ts:359

▸ addListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"end"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.addListener

Defined in

node_modules/@types/node/net.d.ts:360

▸ addListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"error"`
`listener`	(`err`: `Error`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.addListener

Defined in

node_modules/@types/node/net.d.ts:361

▸ addListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"lookup"`
`listener`	(`err`: `Error`, `address`: `string`, `family`: `string` \| `number`, `host`: `string`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.addListener

Defined in

node_modules/@types/node/net.d.ts:362

▸ addListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"ready"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.addListener

Defined in

node_modules/@types/node/net.d.ts:363

▸ addListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"timeout"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.addListener

Defined in

node_modules/@types/node/net.d.ts:364

address

▸ address(): {} | AddressInfo

Returns the bound address, the address family name and port of the socket as reported by the operating system:{ port: 12346, family: 'IPv4', address: '127.0.0.1' }

Since

v0.1.90

Returns

{} | AddressInfo

Inherited from

Socket.address

Defined in

node_modules/@types/node/net.d.ts:218

asIndexedPairs

▸ asIndexedPairs(options?): Readable

This method returns a new stream with chunks of the underlying stream paired with a counter in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

Since

v17.5.0

Parameters

Name	Type
`options?`	`Pick`<`ArrayOptions`, `"signal"`>

Returns

Readable

a stream of indexed pairs.

Inherited from

Socket.asIndexedPairs

Defined in

node_modules/@types/node/stream.d.ts:520

compose

▸ compose<T>(stream, options?): T

Type parameters

Name	Type
`T`	extends `ReadableStream`<`T`>

Parameters

Name	Type
`stream`	`T` \| `ComposeFnParam` \| `Iterable`<`T`> \| `AsyncIterable`<`T`>
`options?`	`Object`
`options.signal`	`AbortSignal`

Returns

T

Inherited from

Socket.compose

Defined in

node_modules/@types/node/stream.d.ts:35

connect

▸ connect(options, connectionListener?): AppiumServerSocket

Initiate a connection on a given socket.

Possible signatures:

socket.connect(options[, connectListener])
socket.connect(path[, connectListener]) for IPC connections.
socket.connect(port[, host][, connectListener]) for TCP connections.
Returns: net.Socket The socket itself.

This function is asynchronous. When the connection is established, the 'connect' event will be emitted. If there is a problem connecting, instead of a 'connect' event, an 'error' event will be emitted with the error passed to the 'error' listener. The last parameter connectListener, if supplied, will be added as a listener for the 'connect' event once.

This function should only be used for reconnecting a socket after'close' has been emitted or otherwise it may lead to undefined behavior.

Parameters

Name	Type
`options`	`SocketConnectOpts`
`connectionListener?`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.connect

Defined in

node_modules/@types/node/net.d.ts:126

▸ connect(port, host, connectionListener?): AppiumServerSocket

Parameters

Name	Type
`port`	`number`
`host`	`string`
`connectionListener?`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.connect

Defined in

node_modules/@types/node/net.d.ts:127

▸ connect(port, connectionListener?): AppiumServerSocket

Parameters

Name	Type
`port`	`number`
`connectionListener?`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.connect

Defined in

node_modules/@types/node/net.d.ts:128

▸ connect(path, connectionListener?): AppiumServerSocket

Parameters

Name	Type
`path`	`string`
`connectionListener?`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.connect

Defined in

node_modules/@types/node/net.d.ts:129

cork

▸ cork(): void

Returns

void

Inherited from

Socket.cork

Defined in

node_modules/@types/node/stream.d.ts:1068

destroy

▸ destroy(error?): AppiumServerSocket

Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable stream will release any internal resources and subsequent calls to push()will be ignored.

Once destroy() has been called any further calls will be a no-op and no further errors except from _destroy() may be emitted as 'error'.

Implementors should not override this method, but instead implement readable._destroy().

Since

v8.0.0

Parameters

Name	Type	Description
`error?`	`Error`	Error which will be passed as payload in `'error'` event

Returns

AppiumServerSocket

Inherited from

Socket.destroy

Defined in

node_modules/@types/node/stream.d.ts:549

drop

▸ drop(limit, options?): Readable

This method returns a new stream with the first limit chunks dropped from the start.

Since

v17.5.0

Parameters

Name	Type	Description
`limit`	`number`	the number of chunks to drop from the readable.
`options?`	`Pick`<`ArrayOptions`, `"signal"`>	-

Returns

Readable

a stream with limit chunks dropped from the start.

Inherited from

Socket.drop

Defined in

node_modules/@types/node/stream.d.ts:506

emit

▸ emit(event, ...args): boolean

Parameters

Name	Type
`event`	`string` \| `symbol`
`...args`	`any`[]

Returns

boolean

Inherited from

Socket.emit

Defined in

node_modules/@types/node/net.d.ts:365

▸ emit(event, hadError): boolean

Parameters

Name	Type
`event`	`"close"`
`hadError`	`boolean`

Returns

boolean

Inherited from

Socket.emit

Defined in

node_modules/@types/node/net.d.ts:366

▸ emit(event): boolean

Parameters

Name	Type
`event`	`"connect"`

Returns

boolean

Inherited from

Socket.emit

Defined in

node_modules/@types/node/net.d.ts:367

▸ emit(event, data): boolean

Parameters

Name	Type
`event`	`"data"`
`data`	`Buffer`

Returns

boolean

Inherited from

Socket.emit

Defined in

node_modules/@types/node/net.d.ts:368

▸ emit(event): boolean

Parameters

Name	Type
`event`	`"drain"`

Returns

boolean

Inherited from

Socket.emit

Defined in

node_modules/@types/node/net.d.ts:369

▸ emit(event): boolean

Parameters

Name	Type
`event`	`"end"`

Returns

boolean

Inherited from

Socket.emit

Defined in

node_modules/@types/node/net.d.ts:370

▸ emit(event, err): boolean

Parameters

Name	Type
`event`	`"error"`
`err`	`Error`

Returns

boolean

Inherited from

Socket.emit

Defined in

node_modules/@types/node/net.d.ts:371

▸ emit(event, err, address, family, host): boolean

Parameters

Name	Type
`event`	`"lookup"`
`err`	`Error`
`address`	`string`
`family`	`string` \| `number`
`host`	`string`

Returns

boolean

Inherited from

Socket.emit

Defined in

node_modules/@types/node/net.d.ts:372

▸ emit(event): boolean

Parameters

Name	Type
`event`	`"ready"`

Returns

boolean

Inherited from

Socket.emit

Defined in

node_modules/@types/node/net.d.ts:373

▸ emit(event): boolean

Parameters

Name	Type
`event`	`"timeout"`

Returns

boolean

Inherited from

Socket.emit

Defined in

node_modules/@types/node/net.d.ts:374

end

▸ end(callback?): AppiumServerSocket

Half-closes the socket. i.e., it sends a FIN packet. It is possible the server will still send some data.

See writable.end() for further details.

Since

v0.1.90

Parameters

Name	Type	Description
`callback?`	() => `void`	Optional callback for when the socket is finished.

Returns

AppiumServerSocket

The socket itself.

Inherited from

Socket.end

Defined in

node_modules/@types/node/net.d.ts:340

▸ end(buffer, callback?): AppiumServerSocket

Parameters

Name	Type
`buffer`	`string` \| `Uint8Array`
`callback?`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.end

Defined in

node_modules/@types/node/net.d.ts:341

▸ end(str, encoding?, callback?): AppiumServerSocket

Parameters

Name	Type
`str`	`string` \| `Uint8Array`
`encoding?`	`BufferEncoding`
`callback?`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.end

Defined in

node_modules/@types/node/net.d.ts:342

eventNames

▸ eventNames(): (string | symbol)[]

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Since

v6.0.0

Returns

(string | symbol)[]

Inherited from

Socket.eventNames

Defined in

node_modules/@types/node/events.d.ts:779

every

▸ every(fn, options?): Promise<boolean>

This method is similar to Array.prototype.every and calls fn on each chunk in the stream to check if all awaited return values are truthy value for fn. Once an fn call on a chunk awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

Since

v17.5.0

Parameters

Name	Type	Description
`fn`	(`data`: `any`, `options?`: `Pick`<`ArrayOptions`, `"signal"`>) => `boolean` \| `Promise`<`boolean`>	a function to call on each chunk of the stream. Async or not.
`options?`	`ArrayOptions`	-

Returns

Promise<boolean>

a promise evaluating to true if fn returned a truthy value for every one of the chunks.

Inherited from

Socket.every

Defined in

node_modules/@types/node/stream.d.ts:488

filter

▸ filter(fn, options?): Readable

This method allows filtering the stream. For each chunk in the stream the fn function will be called and if it returns a truthy value, the chunk will be passed to the result stream. If the fn function returns a promise - that promise will be awaited.

Since

v17.4.0, v16.14.0

Parameters

Name	Type	Description
`fn`	(`data`: `any`, `options?`: `Pick`<`ArrayOptions`, `"signal"`>) => `boolean` \| `Promise`<`boolean`>	a function to filter chunks from the stream. Async or not.
`options?`	`ArrayOptions`	-

Returns

Readable

a stream filtered with the predicate fn.

Inherited from

Socket.filter

Defined in

node_modules/@types/node/stream.d.ts:431

find

▸ find<T>(fn, options?): Promise<undefined | T>

This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

Since

v17.5.0

Type parameters

Name
`T`

Parameters

Name	Type	Description
`fn`	(`data`: `any`, `options?`: `Pick`<`ArrayOptions`, `"signal"`>) => data is T	a function to call on each chunk of the stream. Async or not.
`options?`	`ArrayOptions`	-

Returns

Promise<undefined | T>

a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

Inherited from

Socket.find

Defined in

node_modules/@types/node/stream.d.ts:477

▸ find(fn, options?): Promise<any>

Parameters

Name	Type
`fn`	(`data`: `any`, `options?`: `Pick`<`ArrayOptions`, `"signal"`>) => `boolean` \| `Promise`<`boolean`>
`options?`	`ArrayOptions`

Returns

Promise<any>

Inherited from

Socket.find

Defined in

node_modules/@types/node/stream.d.ts:478

flatMap

▸ flatMap(fn, options?): Readable

This method returns a new stream by applying the given callback to each chunk of the stream and then flattening the result.

It is possible to return a stream or another iterable or async iterable from fn and the result streams will be merged (flattened) into the returned stream.

Since

v17.5.0

Parameters

Name	Type	Description
`fn`	(`data`: `any`, `options?`: `Pick`<`ArrayOptions`, `"signal"`>) => `any`	a function to map over every chunk in the stream. May be async. May be a stream or generator.
`options?`	`ArrayOptions`	-

Returns

Readable

a stream flat-mapped with the function fn.

Inherited from

Socket.flatMap

Defined in

node_modules/@types/node/stream.d.ts:499

forEach

▸ forEach(fn, options?): Promise<void>

This method allows iterating a stream. For each chunk in the stream the fn function will be called. If the fn function returns a promise - that promise will be awaited.

This method is different from for await...of loops in that it can optionally process chunks concurrently. In addition, a forEach iteration can only be stopped by having passed a signal option and aborting the related AbortController while for await...of can be stopped with break or return. In either case the stream will be destroyed.

This method is different from listening to the 'data' event in that it uses the readable event in the underlying machinary and can limit the number of concurrent fn calls.

Since

v17.5.0

Parameters

Name	Type	Description
`fn`	(`data`: `any`, `options?`: `Pick`<`ArrayOptions`, `"signal"`>) => `void` \| `Promise`<`void`>	a function to call on each chunk of the stream. Async or not.
`options?`	`ArrayOptions`	-

Returns

Promise<void>

a promise for when the stream has finished.

Inherited from

Socket.forEach

Defined in

node_modules/@types/node/stream.d.ts:447

getMaxListeners

▸ getMaxListeners(): number

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

Since

v1.0.0

Returns

number

Inherited from

Socket.getMaxListeners

Defined in

node_modules/@types/node/events.d.ts:631

isPaused

▸ isPaused(): boolean

The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.pipe() method. In most typical cases, there will be no reason to use this method directly.

const readable = new stream.Readable();

readable.isPaused(); // === false
readable.pause();
readable.isPaused(); // === true
readable.resume();
readable.isPaused(); // === false

Since

v0.11.14

Returns

boolean

Inherited from

Socket.isPaused

Defined in

node_modules/@types/node/stream.d.ts:284

iterator

▸ iterator(options?): AsyncIterableIterator<any>

The iterator created by this method gives users the option to cancel the destruction of the stream if the for await...of loop is exited by return, break, or throw, or if the iterator should destroy the stream if the stream emitted an error during iteration.

Since

v16.3.0

Parameters

Name	Type	Description
`options?`	`Object`	-
`options.destroyOnReturn?`	`boolean`	When set to `false`, calling `return` on the async iterator, or exiting a `for await...of` iteration using a `break`, `return`, or `throw` will not destroy the stream. Default: `true`.

Returns

AsyncIterableIterator<any>

Inherited from

Socket.iterator

Defined in

node_modules/@types/node/stream.d.ts:414

listenerCount

▸ listenerCount(eventName, listener?): number

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Since

v3.2.0

Parameters

Name	Type	Description
`eventName`	`string` \| `symbol`	The name of the event being listened for
`listener?`	`Function`	The event handler function

Returns

number

Inherited from

Socket.listenerCount

Defined in

node_modules/@types/node/events.d.ts:725

listeners

▸ listeners(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Since

v0.1.26

Parameters

Name	Type
`eventName`	`string` \| `symbol`

Returns

Function[]

Inherited from

Socket.listeners

Defined in

node_modules/@types/node/events.d.ts:644

map

▸ map(fn, options?): Readable

This method allows mapping over the stream. The fn function will be called for every chunk in the stream. If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

Since

v17.4.0, v16.14.0

Parameters

Name	Type	Description
`fn`	(`data`: `any`, `options?`: `Pick`<`ArrayOptions`, `"signal"`>) => `any`	a function to map over every chunk in the stream. Async or not.
`options?`	`ArrayOptions`	-

Returns

Readable

a stream mapped with the function fn.

Inherited from

Socket.map

Defined in

node_modules/@types/node/stream.d.ts:422

off

▸ off(eventName, listener): AppiumServerSocket

Alias for emitter.removeListener().

Since

v10.0.0

Parameters

Name	Type
`eventName`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.off

Defined in

node_modules/@types/node/events.d.ts:604

on

▸ on(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`string`
`listener`	(...`args`: `any`[]) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.on

Defined in

node_modules/@types/node/net.d.ts:375

▸ on(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"close"`
`listener`	(`hadError`: `boolean`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.on

Defined in

node_modules/@types/node/net.d.ts:376

▸ on(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"connect"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.on

Defined in

node_modules/@types/node/net.d.ts:377

▸ on(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"data"`
`listener`	(`data`: `Buffer`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.on

Defined in

node_modules/@types/node/net.d.ts:378

▸ on(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"drain"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.on

Defined in

node_modules/@types/node/net.d.ts:379

▸ on(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"end"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.on

Defined in

node_modules/@types/node/net.d.ts:380

▸ on(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"error"`
`listener`	(`err`: `Error`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.on

Defined in

node_modules/@types/node/net.d.ts:381

▸ on(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"lookup"`
`listener`	(`err`: `Error`, `address`: `string`, `family`: `string` \| `number`, `host`: `string`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.on

Defined in

node_modules/@types/node/net.d.ts:382

▸ on(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"ready"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.on

Defined in

node_modules/@types/node/net.d.ts:383

▸ on(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"timeout"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.on

Defined in

node_modules/@types/node/net.d.ts:384

once

▸ once(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`string`
`listener`	(...`args`: `any`[]) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.once

Defined in

node_modules/@types/node/net.d.ts:385

▸ once(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"close"`
`listener`	(`hadError`: `boolean`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.once

Defined in

node_modules/@types/node/net.d.ts:386

▸ once(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"connect"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.once

Defined in

node_modules/@types/node/net.d.ts:387

▸ once(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"data"`
`listener`	(`data`: `Buffer`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.once

Defined in

node_modules/@types/node/net.d.ts:388

▸ once(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"drain"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.once

Defined in

node_modules/@types/node/net.d.ts:389

▸ once(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"end"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.once

Defined in

node_modules/@types/node/net.d.ts:390

▸ once(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"error"`
`listener`	(`err`: `Error`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.once

Defined in

node_modules/@types/node/net.d.ts:391

▸ once(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"lookup"`
`listener`	(`err`: `Error`, `address`: `string`, `family`: `string` \| `number`, `host`: `string`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.once

Defined in

node_modules/@types/node/net.d.ts:392

▸ once(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"ready"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.once

Defined in

node_modules/@types/node/net.d.ts:393

▸ once(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"timeout"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.once

Defined in

node_modules/@types/node/net.d.ts:394

pause

▸ pause(): AppiumServerSocket

Pauses the reading of data. That is, 'data' events will not be emitted. Useful to throttle back an upload.

Returns

AppiumServerSocket

The socket itself.

Inherited from

Socket.pause

Defined in

node_modules/@types/node/net.d.ts:141

pipe

▸ pipe<T>(destination, options?): T

Type parameters

Name	Type
`T`	extends `WritableStream`<`T`>

Parameters

Name	Type
`destination`	`T`
`options?`	`Object`
`options.end?`	`boolean`

Returns

T

Inherited from

Socket.pipe

Defined in

node_modules/@types/node/stream.d.ts:29

prependListener

▸ prependListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`string`
`listener`	(...`args`: `any`[]) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependListener

Defined in

node_modules/@types/node/net.d.ts:395

▸ prependListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"close"`
`listener`	(`hadError`: `boolean`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependListener

Defined in

node_modules/@types/node/net.d.ts:396

▸ prependListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"connect"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependListener

Defined in

node_modules/@types/node/net.d.ts:397

▸ prependListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"data"`
`listener`	(`data`: `Buffer`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependListener

Defined in

node_modules/@types/node/net.d.ts:398

▸ prependListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"drain"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependListener

Defined in

node_modules/@types/node/net.d.ts:399

▸ prependListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"end"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependListener

Defined in

node_modules/@types/node/net.d.ts:400

▸ prependListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"error"`
`listener`	(`err`: `Error`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependListener

Defined in

node_modules/@types/node/net.d.ts:401

▸ prependListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"lookup"`
`listener`	(`err`: `Error`, `address`: `string`, `family`: `string` \| `number`, `host`: `string`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependListener

Defined in

node_modules/@types/node/net.d.ts:402

▸ prependListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"ready"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependListener

Defined in

node_modules/@types/node/net.d.ts:403

▸ prependListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"timeout"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependListener

Defined in

node_modules/@types/node/net.d.ts:404

prependOnceListener

▸ prependOnceListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`string`
`listener`	(...`args`: `any`[]) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependOnceListener

Defined in

node_modules/@types/node/net.d.ts:405

▸ prependOnceListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"close"`
`listener`	(`hadError`: `boolean`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependOnceListener

Defined in

node_modules/@types/node/net.d.ts:406

▸ prependOnceListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"connect"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependOnceListener

Defined in

node_modules/@types/node/net.d.ts:407

▸ prependOnceListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"data"`
`listener`	(`data`: `Buffer`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependOnceListener

Defined in

node_modules/@types/node/net.d.ts:408

▸ prependOnceListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"drain"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependOnceListener

Defined in

node_modules/@types/node/net.d.ts:409

▸ prependOnceListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"end"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependOnceListener

Defined in

node_modules/@types/node/net.d.ts:410

▸ prependOnceListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"error"`
`listener`	(`err`: `Error`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependOnceListener

Defined in

node_modules/@types/node/net.d.ts:411

▸ prependOnceListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"lookup"`
`listener`	(`err`: `Error`, `address`: `string`, `family`: `string` \| `number`, `host`: `string`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependOnceListener

Defined in

node_modules/@types/node/net.d.ts:412

▸ prependOnceListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"ready"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependOnceListener

Defined in

node_modules/@types/node/net.d.ts:413

▸ prependOnceListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"timeout"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.prependOnceListener

Defined in

node_modules/@types/node/net.d.ts:414

push

▸ push(chunk, encoding?): boolean

Parameters

Name	Type
`chunk`	`any`
`encoding?`	`BufferEncoding`

Returns

boolean

Inherited from

Socket.push

Defined in

node_modules/@types/node/stream.d.ts:404

rawListeners

▸ rawListeners(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Since

v9.4.0

Parameters

Name	Type
`eventName`	`string` \| `symbol`

Returns

Function[]

Inherited from

Socket.rawListeners

Defined in

node_modules/@types/node/events.d.ts:675

read

▸ read(size?): any

The readable.read() method reads data out of the internal buffer and returns it. If no data is available to be read, null is returned. By default, the data is returned as a Buffer object unless an encoding has been specified using the readable.setEncoding() method or the stream is operating in object mode.

The optional size argument specifies a specific number of bytes to read. Ifsize bytes are not available to be read, null will be returned _unless_the stream has ended, in which case all of the data remaining in the internal buffer will be returned.

If the size argument is not specified, all of the data contained in the internal buffer will be returned.

The size argument must be less than or equal to 1 GiB.

The readable.read() method should only be called on Readable streams operating in paused mode. In flowing mode, readable.read() is called automatically until the internal buffer is fully drained.

const readable = getReadableStreamSomehow();

// 'readable' may be triggered multiple times as data is buffered in
readable.on('readable', () => {
  let chunk;
  console.log('Stream is readable (new data received in buffer)');
  // Use a loop to make sure we read all currently available data
  while (null !== (chunk = readable.read())) {
    console.log(`Read ${chunk.length} bytes of data...`);
  }
});

// 'end' will be triggered once when there is no more data available
readable.on('end', () => {
  console.log('Reached end of stream.');
});

Each call to readable.read() returns a chunk of data, or null. The chunks are not concatenated. A while loop is necessary to consume all data currently in the buffer. When reading a large file .read() may return null, having consumed all buffered content so far, but there is still more data to come not yet buffered. In this case a new 'readable' event will be emitted when there is more data in the buffer. Finally the 'end' event will be emitted when there is no more data to come.

Therefore to read a file's whole contents from a readable, it is necessary to collect chunks across multiple 'readable' events:

const chunks = [];

readable.on('readable', () => {
  let chunk;
  while (null !== (chunk = readable.read())) {
    chunks.push(chunk);
  }
});

readable.on('end', () => {
  const content = chunks.join('');
});

A Readable stream in object mode will always return a single item from a call to readable.read(size), regardless of the value of thesize argument.

If the readable.read() method returns a chunk of data, a 'data' event will also be emitted.

Calling read after the 'end' event has been emitted will return null. No runtime error will be raised.

Since

v0.9.4

Parameters

Name	Type	Description
`size?`	`number`	Optional argument to specify how much data to read.

Returns

any

Inherited from

Socket.read

Defined in

node_modules/@types/node/stream.d.ts:201

reduce

▸ reduce<T>(fn, initial?, options?): Promise<T>

This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

If no initial value is supplied the first chunk of the stream is used as the initial value. If the stream is empty, the promise is rejected with a TypeError with the ERR_INVALID_ARGS code property.

The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

Since

v17.5.0

Type parameters

Name	Type
`T`	`any`

Parameters

Name	Type	Description
`fn`	(`previous`: `any`, `data`: `any`, `options?`: `Pick`<`ArrayOptions`, `"signal"`>) => `T`	a reducer function to call over every chunk in the stream. Async or not.
`initial?`	`undefined`	the initial value to use in the reduction.
`options?`	`Pick`<`ArrayOptions`, `"signal"`>	-

Returns

Promise<T>

a promise for the final value of the reduction.

Inherited from

Socket.reduce

Defined in

node_modules/@types/node/stream.d.ts:535

▸ reduce<T>(fn, initial, options?): Promise<T>

Type parameters

Name	Type
`T`	`any`

Parameters

Name	Type
`fn`	(`previous`: `T`, `data`: `any`, `options?`: `Pick`<`ArrayOptions`, `"signal"`>) => `T`
`initial`	`T`
`options?`	`Pick`<`ArrayOptions`, `"signal"`>

Returns

Promise<T>

Inherited from

Socket.reduce

Defined in

node_modules/@types/node/stream.d.ts:536

ref

▸ ref(): AppiumServerSocket

Opposite of unref(), calling ref() on a previously unrefed socket will not let the program exit if it's the only socket left (the default behavior). If the socket is refed calling ref again will have no effect.

Since

v0.9.1

Returns

AppiumServerSocket

The socket itself.

Inherited from

Socket.ref

Defined in

node_modules/@types/node/net.d.ts:232

removeAllListeners

▸ removeAllListeners(event?): AppiumServerSocket

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.

Since

v0.1.26

Parameters

Name	Type
`event?`	`string` \| `symbol`

Returns

AppiumServerSocket

Inherited from

Socket.removeAllListeners

Defined in

node_modules/@types/node/events.d.ts:615

removeListener

▸ removeListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"close"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.removeListener

Defined in

node_modules/@types/node/stream.d.ts:1178

▸ removeListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"data"`
`listener`	(`chunk`: `any`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.removeListener

Defined in

node_modules/@types/node/stream.d.ts:1179

▸ removeListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"drain"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.removeListener

Defined in

node_modules/@types/node/stream.d.ts:1180

▸ removeListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"end"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.removeListener

Defined in

node_modules/@types/node/stream.d.ts:1181

▸ removeListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"error"`
`listener`	(`err`: `Error`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.removeListener

Defined in

node_modules/@types/node/stream.d.ts:1182

▸ removeListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"finish"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.removeListener

Defined in

node_modules/@types/node/stream.d.ts:1183

▸ removeListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"pause"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.removeListener

Defined in

node_modules/@types/node/stream.d.ts:1184

▸ removeListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"pipe"`
`listener`	(`src`: `Readable`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.removeListener

Defined in

node_modules/@types/node/stream.d.ts:1185

▸ removeListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"readable"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.removeListener

Defined in

node_modules/@types/node/stream.d.ts:1186

▸ removeListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"resume"`
`listener`	() => `void`

Returns

AppiumServerSocket

Inherited from

Socket.removeListener

Defined in

node_modules/@types/node/stream.d.ts:1187

▸ removeListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`"unpipe"`
`listener`	(`src`: `Readable`) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.removeListener

Defined in

node_modules/@types/node/stream.d.ts:1188

▸ removeListener(event, listener): AppiumServerSocket

Parameters

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns

AppiumServerSocket

Inherited from

Socket.removeListener

Defined in

node_modules/@types/node/stream.d.ts:1189

resetAndDestroy

▸ resetAndDestroy(): AppiumServerSocket

Close the TCP connection by sending an RST packet and destroy the stream. If this TCP socket is in connecting status, it will send an RST packet and destroy this TCP socket once it is connected. Otherwise, it will call socket.destroy with an ERR_SOCKET_CLOSED Error. If this is not a TCP socket (for example, a pipe), calling this method will immediately throw an ERR_INVALID_HANDLE_TYPE Error.

Since

v18.3.0, v16.17.0

Returns

AppiumServerSocket

Inherited from

Socket.resetAndDestroy

Defined in

node_modules/@types/node/net.d.ts:149

resume

▸ resume(): AppiumServerSocket

Resumes reading after a call to socket.pause().

Returns

AppiumServerSocket

The socket itself.

Inherited from

Socket.resume

Defined in

node_modules/@types/node/net.d.ts:154

setDefaultEncoding

▸ setDefaultEncoding(encoding): AppiumServerSocket

Parameters

Name	Type
`encoding`	`BufferEncoding`

Returns

AppiumServerSocket

Inherited from

Socket.setDefaultEncoding

Defined in

node_modules/@types/node/stream.d.ts:1064

setEncoding

▸ setEncoding(encoding?): AppiumServerSocket

Set the encoding for the socket as a Readable Stream. See readable.setEncoding() for more information.

Since

v0.1.90

Parameters

Name	Type
`encoding?`	`BufferEncoding`

Returns

AppiumServerSocket

The socket itself.

Inherited from

Socket.setEncoding

Defined in

node_modules/@types/node/net.d.ts:135

setKeepAlive

▸ setKeepAlive(enable?, initialDelay?): AppiumServerSocket

Enable/disable keep-alive functionality, and optionally set the initial delay before the first keepalive probe is sent on an idle socket.

Set initialDelay (in milliseconds) to set the delay between the last data packet received and the first keepalive probe. Setting 0 forinitialDelay will leave the value unchanged from the default (or previous) setting.

Enabling the keep-alive functionality will set the following socket options:

SO_KEEPALIVE=1
TCP_KEEPIDLE=initialDelay
TCP_KEEPCNT=10
TCP_KEEPINTVL=1

Since

v0.1.92

Parameters

Name	Type
`enable?`	`boolean`
`initialDelay?`	`number`

Returns

AppiumServerSocket

The socket itself.

Inherited from

Socket.setKeepAlive

Defined in

node_modules/@types/node/net.d.ts:212

setMaxListeners

▸ setMaxListeners(n): AppiumServerSocket

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Since

v0.3.5

Parameters

Name	Type
`n`	`number`

Returns

AppiumServerSocket

Inherited from

Socket.setMaxListeners

Defined in

node_modules/@types/node/events.d.ts:625

setNoDelay

▸ setNoDelay(noDelay?): AppiumServerSocket

Enable/disable the use of Nagle's algorithm.

When a TCP connection is created, it will have Nagle's algorithm enabled.

Nagle's algorithm delays data before it is sent via the network. It attempts to optimize throughput at the expense of latency.

Passing true for noDelay or not passing an argument will disable Nagle's algorithm for the socket. Passing false for noDelay will enable Nagle's algorithm.

Since

v0.1.90

Parameters

Name	Type
`noDelay?`	`boolean`

Returns

AppiumServerSocket

The socket itself.

Inherited from

Socket.setNoDelay

Defined in

node_modules/@types/node/net.d.ts:192

setTimeout

▸ setTimeout(timeout, callback?): AppiumServerSocket

Sets the socket to timeout after timeout milliseconds of inactivity on the socket. By default net.Socket do not have a timeout.

When an idle timeout is triggered the socket will receive a 'timeout' event but the connection will not be severed. The user must manually call socket.end() or socket.destroy() to end the connection.

socket.setTimeout(3000);
socket.on('timeout', () => {
  console.log('socket timeout');
  socket.end();
});

If timeout is 0, then the existing idle timeout is disabled.

The optional callback parameter will be added as a one-time listener for the 'timeout' event.

Since

v0.1.90

Parameters

Name	Type
`timeout`	`number`
`callback?`	() => `void`

Returns

AppiumServerSocket

The socket itself.

Inherited from

Socket.setTimeout

Defined in

node_modules/@types/node/net.d.ts:176

some

▸ some(fn, options?): Promise<boolean>

This method is similar to Array.prototype.some and calls fn on each chunk in the stream until the awaited return value is true (or any truthy value). Once an fn call on a chunk awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

Since

v17.5.0

Parameters

Name	Type	Description
`fn`	(`data`: `any`, `options?`: `Pick`<`ArrayOptions`, `"signal"`>) => `boolean` \| `Promise`<`boolean`>	a function to call on each chunk of the stream. Async or not.
`options?`	`ArrayOptions`	-

Returns

Promise<boolean>

a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

Inherited from

Socket.some

Defined in

node_modules/@types/node/stream.d.ts:466

take

▸ take(limit, options?): Readable

This method returns a new stream with the first limit chunks.

Since

v17.5.0

Parameters

Name	Type	Description
`limit`	`number`	the number of chunks to take from the readable.
`options?`	`Pick`<`ArrayOptions`, `"signal"`>	-

Returns

Readable

a stream with limit chunks taken.

Inherited from

Socket.take

Defined in

node_modules/@types/node/stream.d.ts:513

toArray

▸ toArray(options?): Promise<any[]>

This method allows easily obtaining the contents of a stream.

As this method reads the entire stream into memory, it negates the benefits of streams. It's intended for interoperability and convenience, not as the primary way to consume streams.

Since

v17.5.0

Parameters

Name	Type
`options?`	`Pick`<`ArrayOptions`, `"signal"`>

Returns

Promise<any[]>

a promise containing an array with the contents of the stream.

Inherited from

Socket.toArray

Defined in

node_modules/@types/node/stream.d.ts:456

uncork

▸ uncork(): void

Returns

void

Inherited from

Socket.uncork

Defined in

node_modules/@types/node/stream.d.ts:1069

unpipe

▸ unpipe(destination?): AppiumServerSocket

The readable.unpipe() method detaches a Writable stream previously attached using the pipe method.

If the destination is not specified, then all pipes are detached.

If the destination is specified, but no pipe is set up for it, then the method does nothing.

const fs = require('node:fs');
const readable = getReadableStreamSomehow();
const writable = fs.createWriteStream('file.txt');
// All the data from readable goes into 'file.txt',
// but only for the first second.
readable.pipe(writable);
setTimeout(() => {
  console.log('Stop writing to file.txt.');
  readable.unpipe(writable);
  console.log('Manually close the file stream.');
  writable.end();
}, 1000);

Since

v0.9.4

Parameters

Name	Type	Description
`destination?`	`WritableStream`	Optional specific stream to unpipe

Returns

AppiumServerSocket

Inherited from

Socket.unpipe

Defined in

node_modules/@types/node/stream.d.ts:311

unref

▸ unref(): AppiumServerSocket

Calling unref() on a socket will allow the program to exit if this is the only active socket in the event system. If the socket is already unrefed callingunref() again will have no effect.

Since

v0.9.1

Returns

AppiumServerSocket

The socket itself.

Inherited from

Socket.unref

Defined in

node_modules/@types/node/net.d.ts:225

unshift

▸ unshift(chunk, encoding?): void

Passing chunk as null signals the end of the stream (EOF) and behaves the same as readable.push(null), after which no more data can be written. The EOF signal is put at the end of the buffer and any buffered data will still be flushed.

The readable.unshift() method pushes a chunk of data back into the internal buffer. This is useful in certain situations where a stream is being consumed by code that needs to "un-consume" some amount of data that it has optimistically pulled out of the source, so that the data can be passed on to some other party.

The stream.unshift(chunk) method cannot be called after the 'end' event has been emitted or a runtime error will be thrown.

Developers using stream.unshift() often should consider switching to use of a Transform stream instead. See the API for stream implementers section for more information.

// Pull off a header delimited by \n\n.
// Use unshift() if we get too much.
// Call the callback with (error, header, stream).
const { StringDecoder } = require('node:string_decoder');
function parseHeader(stream, callback) {
  stream.on('error', callback);
  stream.on('readable', onReadable);
  const decoder = new StringDecoder('utf8');
  let header = '';
  function onReadable() {
    let chunk;
    while (null !== (chunk = stream.read())) {
      const str = decoder.write(chunk);
      if (str.includes('\n\n')) {
        // Found the header boundary.
        const split = str.split(/\n\n/);
        header += split.shift();
        const remaining = split.join('\n\n');
        const buf = Buffer.from(remaining, 'utf8');
        stream.removeListener('error', callback);
        // Remove the 'readable' listener before unshifting.
        stream.removeListener('readable', onReadable);
        if (buf.length)
          stream.unshift(buf);
        // Now the body of the message can be read from the stream.
        callback(null, header, stream);
        return;
      }
      // Still reading the header.
      header += str;
    }
  }
}

Unlike push, stream.unshift(chunk) will not end the reading process by resetting the internal reading state of the stream. This can cause unexpected results if readable.unshift() is called during a read (i.e. from within a _read implementation on a custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately, however it is best to simply avoid calling readable.unshift() while in the process of performing a read.

Since

v0.9.11

Parameters

Name	Type	Description
`chunk`	`any`	Chunk of data to unshift onto the read queue. For streams not operating in object mode, `chunk` must be a string, `Buffer`, `Uint8Array`, or `null`. For object mode streams, `chunk` may be any JavaScript value.
`encoding?`	`BufferEncoding`	Encoding of string chunks. Must be a valid `Buffer` encoding, such as `'utf8'` or `'ascii'`.

Returns

void

Inherited from

Socket.unshift

Defined in

node_modules/@types/node/stream.d.ts:377

wrap

▸ wrap(stream): AppiumServerSocket

Prior to Node.js 0.10, streams did not implement the entire node:streammodule API as it is currently defined. (See Compatibility for more information.)

When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable stream that uses the old stream as its data source.

It will rarely be necessary to use readable.wrap() but the method has been provided as a convenience for interacting with older Node.js applications and libraries.

const { OldReader } = require('./old-api-module.js');
const { Readable } = require('node:stream');
const oreader = new OldReader();
const myReader = new Readable().wrap(oreader);

myReader.on('readable', () => {
  myReader.read(); // etc.
});

Since

v0.9.4

Parameters

Name	Type	Description
`stream`	`ReadableStream`	An "old style" readable stream

Returns

AppiumServerSocket

Inherited from

Socket.wrap

Defined in

node_modules/@types/node/stream.d.ts:403

write

▸ write(buffer, cb?): boolean

Sends data on the socket. The second parameter specifies the encoding in the case of a string. It defaults to UTF8 encoding.

Returns true if the entire data was flushed successfully to the kernel buffer. Returns false if all or part of the data was queued in user memory.'drain' will be emitted when the buffer is again free.

The optional callback parameter will be executed when the data is finally written out, which may not be immediately.

See Writable stream write() method for more information.

Since

v0.1.90

Parameters

Name	Type
`buffer`	`string` \| `Uint8Array`
`cb?`	(`err?`: `Error`) => `void`

Returns

boolean

Inherited from

Socket.write

Defined in

node_modules/@types/node/net.d.ts:105

▸ write(str, encoding?, cb?): boolean

Parameters

Name	Type
`str`	`string` \| `Uint8Array`
`encoding?`	`BufferEncoding`
`cb?`	(`err?`: `Error`) => `void`

Returns

boolean

Inherited from

Socket.write

Defined in

node_modules/@types/node/net.d.ts:106

Interface: AppiumServerSocket

Hierarchy

Table of contents

Properties

Methods

Properties

_openReqCount

Defined in

allowHalfOpen

Inherited from

Defined in

bufferSize

Inherited from

Defined in

bytesRead

Inherited from

Defined in

bytesWritten

Inherited from

Defined in

closed

Inherited from

Defined in

connecting

Inherited from

Defined in

destroyed

Inherited from

Defined in

errored

Inherited from

Defined in

localAddress

Inherited from

Defined in

localFamily

Inherited from

Defined in

localPort

Inherited from

Defined in

pending

Inherited from

Defined in

readable

Inherited from

Defined in

readableAborted

Inherited from

Defined in

readableDidRead

Inherited from

Defined in

readableEncoding

Inherited from

Defined in

readableEnded

Inherited from

Defined in

readableFlowing

Inherited from

Defined in

readableHighWaterMark

Inherited from

Defined in

readableLength

Inherited from

Defined in

readableObjectMode

Inherited from

Defined in

readyState

Inherited from

Defined in

remoteAddress

Inherited from

Defined in

remoteFamily

Inherited from

Defined in