Module storage/mapping/MapperUtil

Index

Functions

Functions

Const getAbsolutePath

getAbsolutePath(rootFilepath: string, path: string, identifier?: string): string

- Defined in src/storage/mapping/MapperUtil.ts:18
Get the absolute file path based on the rootFilepath of the store.

Parameters
- rootFilepath: string
  
  The root file path.
- path: string
  
  The relative file path.
- identifier: string = ''
  
  Optional identifier to add to the path.
Returns string

Absolute path of the file.

Const getRelativePath

getRelativePath(baseRequestURI: string, identifier: ResourceIdentifier, logger: Logger): string

- Defined in src/storage/mapping/MapperUtil.ts:32
Strips the baseRequestURI from the identifier and checks if the stripped base URI matches the store's one.

throws

NotFoundHttpError If the identifier does not match the baseRequestURI path of the store.

Parameters
- baseRequestURI: string
  
  Base URL for requests.
- identifier: ResourceIdentifier
  
  Incoming identifier.
- logger: Logger
  
  A logger instance.
Returns string

A string representing the relative path.

Const validateRelativePath

validateRelativePath(path: string, identifier: ResourceIdentifier, logger: Logger): void

- Defined in src/storage/mapping/MapperUtil.ts:50
Check if the given relative path is valid.

throws

BadRequestHttpError If the relative path is invalid.

Parameters
- path: string
  
  A relative path, as generated by getRelativePath.
- identifier: ResourceIdentifier
  
  A resource identifier.
- logger: Logger
  
  A logger instance.
Returns void