expo/src/ts-declarations/whatwg-url-without-unicode.d.ts

The Expo SDK

// NOTE(@kitten): This is based on @types/whatwg-url
declare module 'whatwg-url-without-unicode' {
  /// <reference lib="es2020"/>
  /** https://url.spec.whatwg.org/#url-representation */
  export interface URLRecord {
    scheme: string;
    username: string;
    password: string;
    host: string | number | IPv6Address | null;
    port: number | null;
    path: string | string[];
    query: string | null;
    fragment: string | null;
  }

  /** https://url.spec.whatwg.org/#concept-ipv6 */
  export type IPv6Address = [number, number, number, number, number, number, number, number];

  // NOTE(@kitten): This is a custom modification to add static methods with an overlay
  // We should make this available to users in expo/types, which should be linked to our own Winter implementation,
  // and compatible with built-ins. Until then, we're adding this so we can polyfill properly in `src/winter/url.ts`
  export const URL: URLConstructor;
  export interface URLConstructor {
    new (url: string, base?: string | URL): URL;
    (url: string, base?: string | URL): URL;
    canParse(url: string, base?: string): boolean;
  }

  /** https://url.spec.whatwg.org/#url-class */
  interface URL {
    constructor(url: string, base?: string | URL);

    get href(): string;
    set href(V: string);

    get origin(): string;

    get protocol(): string;
    set protocol(V: string);

    get username(): string;
    set username(V: string);

    get password(): string;
    set password(V: string);

    get host(): string;
    set host(V: string);

    get hostname(): string;
    set hostname(V: string);

    get port(): string;
    set port(V: string);

    get pathname(): string;
    set pathname(V: string);

    get search(): string;
    set search(V: string);

    get searchParams(): URLSearchParams;

    get hash(): string;
    set hash(V: string);

    toJSON(): string;

    readonly [Symbol.toStringTag]: 'URL';
  }

  /** https://url.spec.whatwg.org/#interface-urlsearchparams */
  export class URLSearchParams {
    constructor(
      init?:
        | readonly (readonly [name: string, value: string])[]
        | Iterable<readonly [name: string, value: string]>
        | { readonly [name: string]: string }
        | string
    );

    get size(): number;
    append(name: string, value: string): void;
    delete(name: string, value?: string): void;
    get(name: string): string | null;
    getAll(name: string): string[];
    has(name: string, value?: string): boolean;
    set(name: string, value: string): void;
    sort(): void;

    keys(): IterableIterator<string>;
    values(): IterableIterator<string>;
    entries(): IterableIterator<[name: string, value: string]>;
    forEach<THIS_ARG = void>(
      callback: (this: THIS_ARG, value: string, name: string, searchParams: this) => void,
      thisArg?: THIS_ARG
    ): void;

    readonly [Symbol.toStringTag]: 'URLSearchParams';
    [Symbol.iterator](): IterableIterator<[name: string, value: string]>;
  }

  /** https://url.spec.whatwg.org/#concept-url-parser */
  export function parseURL(
    input: string,
    options?: { readonly baseURL?: URLRecord | undefined }
  ): URLRecord | null;

  /** https://url.spec.whatwg.org/#concept-basic-url-parser */
  export function basicURLParse(
    input: string,
    options?: {
      baseURL?: URLRecord | undefined;
      url?: URLRecord | undefined;
      stateOverride?: StateOverride | undefined;
    }
  ): URLRecord | null;

  /** https://url.spec.whatwg.org/#scheme-start-state */
  export type StateOverride =
    | 'scheme start'
    | 'scheme'
    | 'no scheme'
    | 'special relative or authority'
    | 'path or authority'
    | 'relative'
    | 'relative slash'
    | 'special authority slashes'
    | 'special authority ignore slashes'
    | 'authority'
    | 'host'
    | 'hostname'
    | 'port'
    | 'file'
    | 'file slash'
    | 'file host'
    | 'path start'
    | 'path'
    | 'opaque path'
    | 'query'
    | 'fragment';

  /** https://url.spec.whatwg.org/#concept-url-serializer */
  export function serializeURL(urlRecord: URLRecord, excludeFragment?: boolean): string;

  /** https://url.spec.whatwg.org/#concept-host-serializer */
  export function serializeHost(host: string | number | IPv6Address): string;

  /** https://url.spec.whatwg.org/#url-path-serializer */
  export function serializePath(urlRecord: URLRecord): string;

  /** https://url.spec.whatwg.org/#serialize-an-integer */
  export function serializeInteger(number: number): string;

  /** https://html.spec.whatwg.org#ascii-serialisation-of-an-origin */
  export function serializeURLOrigin(urlRecord: URLRecord): string;

  /** https://url.spec.whatwg.org/#set-the-username */
  export function setTheUsername(urlRecord: URLRecord, username: string): void;

  /** https://url.spec.whatwg.org/#set-the-password */
  export function setThePassword(urlRecord: URLRecord, password: string): void;

  /** https://url.spec.whatwg.org/#url-opaque-path */
  export function hasAnOpaquePath(urlRecord: URLRecord): boolean;

  /** https://url.spec.whatwg.org/#cannot-have-a-username-password-port */
  export function cannotHaveAUsernamePasswordPort(urlRecord: URLRecord): boolean;

  /** https://url.spec.whatwg.org/#percent-decode */
  export function percentDecodeBytes(buffer: TypedArray): Uint8Array;

  /** https://url.spec.whatwg.org/#string-percent-decode */
  export function percentDecodeString(string: string): Uint8Array;

  export type TypedArray =
    | Uint8Array
    | Uint8ClampedArray
    | Uint16Array
    | Uint32Array
    | Int8Array
    | Int16Array
    | Int32Array
    | Float32Array
    | Float64Array;
}