PortFromString - API reference

API reference › @evolu/common › Type › PortFromString

const PortFromString: transform(
  "PortFromString",
  IntFromString,
  Port,
  { from: ok, to: identity },
);

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

Parses a decimal integer string and validates it as a Port.

Uses IntFromString for decimal parsing, including its rejection of whitespace, plus signs, fractions, and exponent notation.

Example

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

assertOk(PortFromString.fromUnknown("0"), 0);
assertOk(PortFromString.fromUnknown("4000"), 4000);
assertErr(PortFromString.fromUnknown("65536"));
assertErr(PortFromString.fromUnknown("http"));
assertEqual(PortFromString.to(PortFromString.orThrow("04000")), "4000");