Documentation navigation

Published API · 0.1.0-rc.1

foldkit · url

Published foldkit API declarations for url.

./url

@wsagency/wseffect-foldkit · MIT · source · MIT license · WS-AGENCY-NOTICE · THIRD-PARTY-NOTICES

This entry point is published in @wsagency/wseffect-foldkit@0.1.0-rc.1. Import it from the package subpath shown below; the signatures and documentation are read from the installed package declarations.

import * as Wseffect from '@wsagency/wseffect-foldkit/url'

Exported declarations

fromString

Parses a URL string into a `Url`, returning `Option.None` if invalid.

fromString: (str: string) => Option.Option<{
    readonly protocol: string;
    readonly host: string;
    readonly port: Option.Option<string>;
    readonly pathname: string;
    readonly search: Option.Option<string>;
    readonly hash: Option.Option<string>;
}>

toString

Serializes a `Url` back to a string.

toString: (url: Url) => string

Url

export type Url = typeof Url.Type;

Url

Schema representing a parsed URL with protocol, host, port, pathname, search, and hash fields.

Url: Schema.Struct<{
    readonly protocol: Schema.String;
    readonly host: Schema.String;
    readonly port: Schema.Option<Schema.String>;
    readonly pathname: Schema.String;
    readonly search: Schema.Option<Schema.String>;
    readonly hash: Schema.Option<Schema.String>;
}>