the-moby-effect
Version:
Moby/Docker API client built using effect-ts
43 lines • 2.13 kB
TypeScript
/**
* Operating system port schema.
*
* @since 1.0.0
*/
import * as Schema from "effect/Schema";
/**
* A set of operating system ports.
*
* @since 1.0.0
* @category Schemas
* @see https://github.com/docker/go-connections/blob/5df8d2b30ca886f2d94740ce3c54abd58a5bb2c9/nat/nat.go#L23
*/
export declare const PortSet: Schema.$Record<Schema.Union<readonly [Schema.TemplateLiteral<readonly [Schema.Number]>, Schema.TemplateLiteral<readonly [Schema.Number, "/", Schema.Literal<"tcp">]>, Schema.TemplateLiteral<readonly [Schema.Number, "/", Schema.Literal<"udp">]>]>, Schema.ObjectKeyword>;
declare const PortBinding_base: Schema.Class<PortBinding, Schema.Struct<{
readonly HostPort: Schema.compose<Schema.brand<Schema.Int, "Port">, Schema.NumberFromString>;
readonly HostIp: Schema.optional<Schema.Union<readonly [Schema.Literal<"">, Schema.Union<readonly [Schema.decodeTo<Schema.Struct<{
readonly family: Schema.Literal<"ipv4">;
readonly ip: Schema.brand<Schema.String, "IPv4">;
}>, Schema.String, never, never>, Schema.decodeTo<Schema.Struct<{
readonly family: Schema.Literal<"ipv6">;
readonly ip: Schema.brand<Schema.String, "IPv6">;
}>, Schema.String, never, never>]>]>>;
}>, {}>;
/**
* A port binding between the exposed port (container) and the host.
*
* @since 1.0.0
* @category Schemas
* @see https://github.com/docker/go-connections/blob/5df8d2b30ca886f2d94740ce3c54abd58a5bb2c9/nat/nat.go#L11-L17
*/
export declare class PortBinding extends PortBinding_base {
}
/**
* Port mapping between the exposed port (container) and the host.
*
* @since 1.0.0
* @category Schemas
* @see https://github.com/docker/go-connections/blob/5df8d2b30ca886f2d94740ce3c54abd58a5bb2c9/nat/nat.go#L20
*/
export declare const PortMap: Schema.$Record<Schema.Union<readonly [Schema.TemplateLiteral<readonly [Schema.Number]>, Schema.TemplateLiteral<readonly [Schema.Number, "/", Schema.Literal<"tcp">]>, Schema.TemplateLiteral<readonly [Schema.Number, "/", Schema.Literal<"udp">]>]>, Schema.NullOr<Schema.$Array<typeof PortBinding>>>;
export {};
//# sourceMappingURL=port.d.ts.map