fast-uri/types/index.d.ts

Dependency-free RFC 3986 URI toolbox

type FastUri = typeof fastUri

declare namespace fastUri {
  export interface URIComponent {
    scheme?: string;
    userinfo?: string;
    host?: string;
    /**
     * Zone identifier of a zoned IPv6 host, e.g. `"eth0"` or `"25eth0"`. Set by
     * `parse` for a bracketed IPv6 literal so `serialize`/`normalize` can
     * reproduce the exact zone without re-deriving it from the ambiguous
     * single-`%` form. It is validated on use, so a value that does not match
     * `host` (for example after `host` is reassigned) is ignored.
     *
     * When building a component object by hand, set `ipv6Zone` to disambiguate
     * a single-`%` host whose zone is ambiguous (a zone beginning with `25`
     * is re-read as a `%25` separator). Without it, `serialize` falls back to
     * a best-effort heuristic and may reinterpret such a zone, e.g. `{ host:
     * "fe80::1%25eth0" }` serializes to `[fe80::1%25eth0]` (zone `eth0`), while
     * `{ host: "fe80::1%25eth0", ipv6Zone: "25eth0" }` serializes to
     * `[fe80::1%2525eth0]` (zone `25eth0`).
     */
    ipv6Zone?: string;
    port?: number | string;
    path?: string;
    query?: string;
    fragment?: string;
    reference?: string;
    nid?: string;
    nss?: string;
    resourceName?: string;
    secure?: boolean;
    uuid?: string;
    error?: string;
    to?: string[];
    subject?: string;
    body?: string;
    headers?: { [hfname: string]: string };
  }
  export interface Options {
    scheme?: string;
    reference?: string;
    unicodeSupport?: boolean;
    domainHost?: boolean;
    absolutePath?: boolean;
    tolerant?: boolean;
    skipEscape?: boolean;
    nid?: string;
  }

  export function normalize (uri: string, opts?: Options): string
  export function normalize (uri: URIComponent, opts?: Options): URIComponent
  export function normalize (uri: any, opts?: Options): any

  export function resolve (baseURI: string, relativeURI: string, options?: Options): string

  export function resolveComponent (base: URIComponent, relative: URIComponent, options?: Options, skipNormalization?: boolean): URIComponent

  export function parse (uri: string, opts?: Options): URIComponent

  export function serialize (component: URIComponent, opts?: Options): string

  export function equal (uriA: string, uriB: string): boolean

  export function resolve (base: string, path: string): string

  export const fastUri: FastUri
  export { fastUri as default }
}

export = fastUri