toFSPath | WebHare Platform SDK

Function toFSPath

Resolve a resource path to a filesystem path

Param: resource

Path to resolve

Param: allowUnmatched

Do not fail if the path cannot be matched to a filesystem path

Param: keepUnmatched

Return the original path if unmatched. Implies allowUnmatched

Returns

Absolute file system path. A succesful return does not imply the path actually exists

Throws

If the path cannot be mapped to a filesystem path

toFSPath(resource: string, options: { keepUnmatched: true }): string
Parameters
- resource: string
- options: { keepUnmatched: true }
Returns string
- Defined in jssdk/services/src/resources.ts:4
toFSPath(resource: string, options: { allowUnmatched: true }): null | string
Parameters
- resource: string
- options: { allowUnmatched: true }
Returns null | string
- Defined in jssdk/services/src/resources.ts:5
toFSPath(
resource: string,
options?: { allowUnmatched?: boolean; keepUnmatched?: boolean },
): string
Parameters
- resource: string
- Optionaloptions: { allowUnmatched?: boolean; keepUnmatched?: boolean }
Returns string
- Defined in jssdk/services/src/resources.ts:6