Port - API reference

API reference › @evolu/common › Type › Port

type Port = number &
  Brand<"NonNaN"> &
  Brand<"Finite"> &
  Brand<"Int"> &
  Brand<"NonNegative"> &
  Brand<"LessThanOrEqualTo65535"> &
  Brand<"Port">;

Defined in: packages/common/src/Type.ts:8353

A TCP or UDP port as an integer from zero through 65535, inclusive.

When binding a server, zero requests an automatically assigned port. Use PortFromString for configuration values supplied as text.

Example

import { assertErr, assertOk, Port } from "@evolu/common";

assertOk(Port.fromUnknown(0), 0);
assertOk(Port.fromUnknown(4000), 4000);
assertOk(Port.fromUnknown(65535), 65535);
assertErr(Port.fromUnknown(-1));
assertErr(Port.fromUnknown(65536));
assertErr(Port.fromUnknown(4000.5));