@types/psl
TypeScript icon, indicating that this package has built-in type declarations

1.1.3 • Public • Published

Installation

npm install --save @types/psl

Summary

This package contains type definitions for psl (https://github.com/wrangr/psl#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/psl.

index.d.ts

export as namespace psl;

export function parse(domain: string): ParsedDomain | ParseError;

export function get(domain: null | undefined): null;
export function get(domain: string): string | null;

export function isValid(domain: string): boolean;

export interface ParsedDomain {
    tld: string | null;
    sld: string | null;
    domain: string | null;
    subdomain: string | null;
    listed: boolean;
    input: string;
    error: undefined;
}

export interface ParseError {
    input: string;
    error: {
        code:
            | "DOMAIN_TOO_SHORT"
            | "DOMAIN_TOO_LONG"
            | "LABEL_STARTS_WITH_DASH"
            | "LABEL_ENDS_WITH_DASH"
            | "LABEL_TOO_LONG"
            | "LABEL_TOO_SHORT"
            | "LABEL_INVALID_CHARS";
        message: string;
    };
}

Additional Details

  • Last updated: Tue, 07 Nov 2023 09:09:39 GMT
  • Dependencies: none

Credits

These definitions were written by BendingBender.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/psl

Weekly Downloads

140,645

Version

1.1.3

License

MIT

Unpacked Size

4.11 kB

Total Files

5

Last publish

Collaborators

  • types