Frodo Library - v5.0.0-5
    Preparing search index...

    Type Alias ExportImport

    type ExportImport = {
        appendTextToFile(data: string, filename: string): void;
        convertBase64TextToArray(b64text: string): any[];
        convertBase64UrlTextToArray(b64UTF8Text: string): any[];
        convertTextArrayToBase64(textArray: string[]): string;
        convertTextArrayToBase64Url(textArray: string[]): any;
        escapePlaceholders(content: object): object;
        findFilesByName(fileName: string, fast?: boolean, path?: string): string[];
        getFilePath(fileName: string, mkdirs?: boolean): string;
        getMetadata(): ExportMetaData;
        getRealmString(): string;
        getTypedFilename(name: string, type: string, suffix?: string): string;
        getWorkingDirectory(mkdirs?: boolean): string;
        isValidUrl(urlString: string): boolean;
        parseUrl(href: string): any;
        readFiles(directory: string): Promise<{ content: string; path: string }[]>;
        readJsonFile(
            filePath: string | number,
            resolvePlaceholders?: boolean,
        ): object;
        saveJsonToFile(
            data: object,
            filename: string,
            includeMeta?: boolean,
            keepRev?: boolean,
            keepModifiedProperties?: boolean,
        ): boolean;
        saveTextToFile(data: string, filename: string): boolean;
        saveToFile(
            type: string,
            data: object,
            identifier: string,
            filename: string,
            includeMeta?: boolean,
            keepModifiedProperties?: boolean,
        ): void;
        substituteEnvParams(input: string, reader: Reader): string;
        titleCase(input: string): string;
        unescapePlaceholders(content: string): string;
        unSubstituteEnvParams(input: string, reader: Reader): string;
        validateImport(metadata: any): boolean;
    }
    Index
    appendTextToFile convertBase64TextToArray convertBase64UrlTextToArray convertTextArrayToBase64 convertTextArrayToBase64Url escapePlaceholders findFilesByName getFilePath getMetadata getRealmString getTypedFilename getWorkingDirectory isValidUrl parseUrl readFiles readJsonFile saveJsonToFile saveTextToFile saveToFile substituteEnvParams titleCase unescapePlaceholders unSubstituteEnvParams validateImport

    • Append text data to file

      Parameters

      • data: string

        text data

      • filename: string

        file name

      Returns void

    • Find files by name

      Parameters

      • fileName: string

        file name to search for

      • Optionalfast: boolean

        return first result and stop search

      • Optionalpath: string

        path to directory where to start the search

      Returns string[]

      array of found file paths relative to starting directory

    • Parameters

      • fileName: string
      • Optionalmkdirs: boolean

      Returns string

    • Parameters

      • name: string
      • type: string
      • Optionalsuffix: string

      Returns string

    • Check if a string is a valid URL

      Parameters

      • urlString: string

        input string to be evaluated

      Returns boolean

      true if a valid URL, false otherwise

    • find all (nested) files in a directory

      Parameters

      • directory: string

        directory to search

      Returns Promise<{ content: string; path: string }[]>

      list of files

    • Parameters

      • filePath: string | number
      • OptionalresolvePlaceholders: boolean

      Returns object

    • Save JSON object to file

      Parameters

      • data: object

        data object

      • filename: string

        file name

      • OptionalincludeMeta: boolean

        true to include metadata, false otherwise. Default: true

      • OptionalkeepRev: boolean

        keep the _rev key from objects. Default: false

      • OptionalkeepModifiedProperties: boolean

        true to keep modified properties in the json, otherwise delete them. Default: false

      Returns boolean

      true if successful, false otherwise

    • Save text data to file

      Parameters

      • data: string

        text data

      • filename: string

        file name

      Returns boolean

      true if successful, false otherwise

    • Save object to file in Frodo export format

      Parameters

      • type: string
      • data: object

        data object

      • identifier: string

        key of identifier in the data object

      • filename: string

        file name

      • OptionalincludeMeta: boolean

        true to include metadata, false otherwise. Default: true

      • OptionalkeepModifiedProperties: boolean

        true to keep modified properties in the json, otherwise delete them. Default: false

      Returns void

    • Parameters

      • input: string
      • reader: Reader

      Returns string

    • Parameters

      • input: string
      • reader: Reader

      Returns string

    Settings
    Member Visibility

    On This Page
    Methods