Skip to content

SocketServer

7 exports Added in v1.0.0 Source

Errors

ErrorTypeId

Added in v1.0.0 Source

Signature

declare const ErrorTypeId: unique symbol;

ErrorTypeId type

Added in v1.0.0 Source

Signature

type ErrorTypeId = typeof ErrorTypeId;

Signature

declare class SocketServerError extends YieldableError<this> & {
  readonly _tag: "SocketServerError";
} & Readonly<{
  readonly cause: unknown;
  readonly reason: "Unknown" | "Open";
}> {
  constructor(args: {
    readonly cause: unknown;
    readonly reason: "Unknown" | "Open";
  });
  readonly [ErrorTypeId]: typeof ErrorTypeId;
  message: string;
}

Models

Address type

Added in v1.0.0 Source

Signature

type Address = UnixAddress | TcpAddress;

TcpAddress interface

Added in v1.0.0 Source

Signature

interface TcpAddress {
  readonly _tag: "TcpAddress";
  readonly hostname: string;
  readonly port: number;
}

UnixAddress interface

Added in v1.0.0 Source

Signature

interface UnixAddress {
  readonly _tag: "UnixAddress";
  readonly path: string;
}

Tags

SocketServer

Added in v1.0.0 Source

Signature

declare class SocketServer extends any {
  constructor();
}