Class AsyncServer

Async server for map stream operations.

Example

const server = new mapstream.AsyncServer(async function* (datum) {
  // Yield multiple messages as a stream
  yield new mapstream.Message(Buffer.from('first'));
  yield new mapstream.Message(Buffer.from('second'));
});

Index

Constructors

constructor

Methods

start stop

Constructors

constructor

new AsyncServer(mapFn: MapStreamCallback): mapstream.AsyncServer
Create a new map stream server.
Parameters
- mapFn: MapStreamCallback
  Async generator function that yields output messages
Returns mapstream.AsyncServer
- Defined in index.ts:1595

Methods

start

start(sockFile?: string | null, infoFile?: string | null): Promise<void>
Start the map stream server.
Parameters
- OptionalsockFile: string | null
  Optional custom Unix socket path
- OptionalinfoFile: string | null
  Optional path for server info file
Returns Promise<void>
- Defined in index.ts:1616

stop

stop(): void
Stop the server gracefully.

Returns void
- Defined in index.ts:1623

Class AsyncServer

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns mapstream.AsyncServer

Methods

start

Parameters

Returns Promise<void>

stop

Returns void

Settings

On This Page