Type Alias ExportImport

ExportImport: {
    appendTextToFile(data: string, filename: string): void;
    convertBase64TextToArray(b64text: string): any[];
    convertBase64UrlTextToArray(b64UTF8Text: string): any[];
    convertTextArrayToBase64(textArray: string[]): string;
    convertTextArrayToBase64Url(textArray: string[]): any;
    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 }[]>;
    saveJsonToFile(
        data: object,
        filename: string,
        includeMeta?: boolean,
    ): boolean;
    saveTextToFile(data: string, filename: string): boolean;
    saveToFile(
        type: string,
        data: object,
        identifier: string,
        filename: string,
        includeMeta?: boolean,
    ): void;
    substituteEnvParams(input: string, reader: Reader): string;
    titleCase(input: string): string;
    unSubstituteEnvParams(input: string, reader: Reader): string;
    validateImport(metadata: any): boolean;
}

Type declaration

  • appendTextToFile:function
    • appendTextToFile(data: string, filename: string): void

      Append text data to file

      Parameters

      • data: string

        text data

      • filename: string

        file name

      Returns void

  • convertBase64TextToArray:function
  • convertBase64UrlTextToArray:function
  • convertTextArrayToBase64:function
  • convertTextArrayToBase64Url:function
  • findFilesByName:function
    • findFilesByName(fileName: string, fast?: boolean, path?: string): string[]

      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

  • getFilePath:function
    • getFilePath(fileName: string, mkdirs?: boolean): string

      Parameters

      • fileName: string
      • Optionalmkdirs: boolean

      Returns string

  • getMetadata:function
  • getRealmString:function
  • getTypedFilename:function
    • getTypedFilename(name: string, type: string, suffix?: string): string

      Parameters

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

      Returns string

  • getWorkingDirectory:function
  • isValidUrl:function
    • isValidUrl(urlString: string): boolean

      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

  • parseUrl:function
  • readFiles:function
    • readFiles(directory: string): Promise<{ content: string; path: string }[]>

      find all (nested) files in a directory

      Parameters

      • directory: string

        directory to search

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

      list of files

  • saveJsonToFile:function
    • saveJsonToFile(data: object, filename: string, includeMeta?: boolean): boolean

      Save JSON object to file

      Parameters

      • data: object

        data object

      • filename: string

        file name

      • OptionalincludeMeta: boolean

        true to include metadata, false otherwise. Default: true

      Returns boolean

      true if successful, false otherwise

  • saveTextToFile:function
    • saveTextToFile(data: string, filename: string): boolean

      Save text data to file

      Parameters

      • data: string

        text data

      • filename: string

        file name

      Returns boolean

      true if successful, false otherwise

  • saveToFile:function
    • saveToFile(
          type: string,
          data: object,
          identifier: string,
          filename: string,
          includeMeta?: boolean,
      ): void

      Parameters

      • type: string
      • data: object
      • identifier: string
      • filename: string
      • OptionalincludeMeta: boolean

      Returns void

  • substituteEnvParams:function
    • substituteEnvParams(input: string, reader: Reader): string

      Parameters

      • input: string
      • reader: Reader

      Returns string

  • titleCase:function
  • unSubstituteEnvParams:function
    • unSubstituteEnvParams(input: string, reader: Reader): string

      Parameters

      • input: string
      • reader: Reader

      Returns string

  • validateImport:function

Settings

Member Visibility