@types/relateurl/index.d.ts

TypeScript definitions for relateurl

declare namespace RelateUrl {
    interface Options {
        /**
         * Type: Object
         * Default value: {ftp:21, http:80, https:443}
         *
         * Extend the list with any ports you need. Any URLs containing these default ports will have them removed. Example: http://example.com:80/ will become http://example.com/.
         */
        defaultPorts?: Object | undefined;

        /**
         * Type: Array
         * Default value: ["index.html"]
         *
         * Extend the list with any resources you need. Works with options.removeDirectoryIndexes.
         */
        directoryIndexes?: string[] | undefined;

        /**
         * Type: Boolean
         * Default value: false
         *
         * This will, for example, consider any domains containing http://www.example.com/ to be related to any that contain http://example.com/.
         */
        ignore_www?: boolean | undefined;

        /**
         * Type: constant or String
         * Choices: RelateUrl.ABSOLUTE,RelateUrl.PATH_RELATIVE,RelateUrl.ROOT_RELATIVE,RelateUrl.SHORTEST
         * Choices: "absolute","pathRelative","rootRelative","shortest"
         * Default value: RelateUrl.SHORTEST
         *
         * RelateUrl.ABSOLUTE will produce an absolute URL. Overrides options.schemeRelative with a value of false.
         * RelateUrl.PATH_RELATIVE will produce something like ../child-of-parent/etc/.
         * RelateUrl.ROOT_RELATIVE will produce something like /child-of-root/etc/.
         * RelateUrl.SHORTEST will choose whichever is shortest between root- and path-relative.
         */
        output?: string | undefined;

        /**
         * Type: Array
         * Default value: ["data","javascript","mailto"]
         *
         * Extend the list with any additional schemes. Example: javascript:something will not be modified.
         */
        rejectedSchemes?: string[] | undefined;

        /**
         * Type: Boolean
         * Default value: false
         *
         * Remove user authentication information from the output URL.
         */
        removeAuth?: boolean | undefined;

        /**
         * Type: Boolean
         * Default value: true
         *
         * Remove any resources that match any found in options.directoryIndexes.
         */
        removeDirectoryIndexes?: boolean | undefined;

        /**
         * Type: Boolean
         * Default value: false
         *
         * Remove empty query variables. Example: http://domain.com/?var1&var2=&var3=asdf will become http://domain.com/?var3=adsf. This does not apply to unrelated URLs (with other protocols, auths, hosts and/or ports).
         */
        removeEmptyQueries?: boolean | undefined;

        /**
         * Type: Boolean
         * Default value: true
         *
         * Remove trailing slashes from root paths. Example: http://domain.com/?var will become http://domain.com?var while http://domain.com/dir/?var will not be modified.
         */
        removeRootTrailingSlash?: boolean | undefined;

        /**
         * Type: Boolean
         * Default value: true
         *
         * Output URLs relative to the scheme. Example: http://example.com/ will become //example.com/.
         */
        schemeRelative?: boolean | undefined;

        /**
         * Type: String
         * Default value: undefined
         *
         * An options-based version of the from argument. If both are specified, from takes priority.
         */
        site?: string | undefined;

        /**
         * Type: Boolean
         * Default value: true
         *
         * Passed to Node's url.parse.
         */
        slashesDenoteHost?: boolean | undefined;
    }
}

declare class RelateUrl {
    static ABSOLUTE: string;
    static PATH_RELATIVE: string;
    static ROOT_RELATIVE: string;
    static SHORTEST: string;

    static relate(from: string, to: string, options?: RelateUrl.Options): string;

    constructor(from: string, options?: RelateUrl.Options);
    relate(to: string, options?: RelateUrl.Options): string;
}

export = RelateUrl;