process-pathlike-param v1.0.3

Process Pathlike Param

Small utility module that turns a path-like url or string into an absolute system path. Input can be a string or a buffer and it optionally checks if the path exists.

get it from npm:

npm i process-pathlike-param

Usage

Basic

import { processPathParam, processPathParamSync } from 'process-pathlike-param'

// for input validation
async function someExposedApi (path) {
  path = await processPathParam(path)
  /* ...code using system path */
}

// or sync
function someExposedApiSync (path) {
  path = processPathParamSync(path)
  /* ...code using system path */
}

This function can now be called with various pathLike params

// with a relative of absolute path string
someExposedApi('/absolute/path/to/file')
someExposedApi('../path/to/file')

// with a file url string
someExposedApi('file:///url/to/file')

// with a [WHATWG compatible file-URL-object](https://url.spec.whatwg.org/#url-class)
someExposedApi({
  protocol: 'file:',
  pathname: '/absolute/path/to/file',
})

// with a NodeJS Buffer or Unit8Array
const buffer = Buffer.from('/absolute/path/to/file')
// => <Buffer 2f 61 62 73 6f 6c 75 74 65 2f 70 61 74 68 2f 74 6f 2f 66 69 6c 65>

someExposedApi(buffer)

With optional Parameters

The function can be called with a second parameter to specify the BufferEncoding or to also check wether the given path exists on disk.

If the file should be checked, the function will return both the path and a boolean in an array like so: [path, boolean]

if no Buffer Encoding is given, the default will be UTF8

A optional parameter can be in the form of:

• a boolean this will check if the file exists => [path, boolean]
• a BufferEncoding
• an object { 'check': boolean, encoding: BufferEncoding }

// passible overloads as per the [.d.ts](@types/main.d.ts):
export async function processPathParam(pathLike: PathLike, options?: Options & {check?: false}):
/* returns */ Promise<string>
export async function processPathParam(pathLike: PathLike, encoding?: BufferEncoding):
/* returns */ Promise<string>
export async function processPathParam(pathLike: PathLike, options: Options & {check: true}):
/* returns */ Promise<[string, boolean]>
export async function processPathParam(pathLike: PathLike, check: true):
/* returns */ Promise<[string, boolean]>