Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileIdentifierMapper

Supports mapping a file to an URL and back.

Hierarchy

  • FileIdentifierMapper

Implemented by

Index

Properties

Properties

mapFilePathToUrl

mapFilePathToUrl: (filePath: string, isContainer: boolean) => Promise<ResourceLink>

Type declaration

    • (filePath: string, isContainer: boolean): Promise<ResourceLink>

    • Maps the given file path to an URL and determines the content-type

      Parameters

      • filePath: string

        The input file path.

      • isContainer: boolean

        If the path corresponds to a file.

      Returns Promise<ResourceLink>

      A ResourceLink with all the necessary metadata.

mapUrlToFilePath

mapUrlToFilePath: (identifier: ResourceIdentifier, contentType?: string) => Promise<ResourceLink>

Type declaration

    • Maps the given resource identifier / URL to a file path. Determines the content-type if no content-type was provided by finding the corresponding file. If there is no corresponding file a file path will be generated. For containers the content-type input gets ignored.

      Parameters

      • identifier: ResourceIdentifier

        The input identifier.

      • Optional contentType: string

        The (optional) content-type of the resource.

      Returns Promise<ResourceLink>

      A ResourceLink with all the necessary metadata.