urisanity/types/index.d.ts

vet URIs in web and web-like applications with confidence

// Type definitions for URI Sanity 0.1.x
// Project: https://github.com/codesplinta/URISanity

declare module 'urisanity' {
    declare type Options = {
      allowScriptOrDataURI?: boolean,
      allowFileSystemURI?: boolean,
      allowCommsAppURI?: boolean,
      allowDBConnectionStringURI?: boolean,
      allowBrowserSpecificURI?: boolean,
      allowWebTransportURI?: boolean,
      allowServiceAPIURI?: boolean
    };
    declare type Params = string | Record<string, unknown>;

    export const vet = (url: string, options?: Options) => string;
    export const isSameOrigin = (uri: string) => boolean;
    export const extractParamValueFromUri = (uri: string, queryParamName: string) => string;
    export const checkParamsOverWhiteList = (uri: string, paramsWhiteList?: string[], params?: Params) => boolean;
}