Package Exports

@igor.dvlpr/my-file-path
@igor.dvlpr/my-file-path/dist/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@igor.dvlpr/my-file-path) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

My file path

🌟 An npm module that strongly types file paths! 🥊

💖 Support further development
I work hard for every project, including this one and your support means a lot to me!
Consider buying me a coffee. ☕
Thank you for supporting my efforts! 🙏😊

@igorskyflyer

🕵🏼 Usage

Install it by executing:

npm i "@igor.dvlpr/my-file-path"

🤹🏼 API

The module exposes a generic type and 3 generic functions.

Type

type FilePath<ext extends string>

Use this type for compile-time safety.

index.ts

type JsonFile = FilePath<'json'>

const filePathJson: JsonFile = 'abc.json' // works in the IDE
const filePathTxt: JsonFile = 'abc.txt' // will not work in the IDE

isMyFilePath

function isMyFilePath<Ext extends string>(
  filePath: string,
  extension: Ext
): boolean

Checks whether the provided filepath conforms with the provided file extension.

Generic parameter:

Ext - the file extension to use with the generic, without a leading dot.

Function parameters:

filePath - the filepath to check. extension - the file extension to perform the check with.

Will not throw. Returns a boolean.

createMyFilePath

function createMyFilePath<Ext extends string>(
  filePath: string,
  extension: Ext
): FilePath<Ext>

Checks whether the provided filepath conforms with the provided file extension and returns it if true. Otherwise it returns an empty string.

Generic parameter:

Ext - the file extension to use with the generic, without a leading dot.

Function parameters:

filePath - the filepath to check. extension - the file extension to perform the check with.

Will not throw. Returns a FilePath<Ext>.

assertMyFilePath

function assertMyFilePath<Ext extends string>(
  filePath: string,
  extension: Ext,
  errorMessage?: string
): void

Asserts whether the provided filepath conforms with the provided file extension.

Generic parameter:

Ext - the file extension to use with the generic, without a leading dot.

Function parameters:

filePath - the filepath to check. extension - the file extension to perform the check with. errorMessage - the error message to throw.

Will throw if the filepath doesn't conform the provided extension. Returns a void.

🪪 License

Licensed under the MIT license which is available here, MIT license.

uPath

🎍 Provides a universal way of formatting file-paths in Unix-like and Windows operating systems as an alternative to the built-in path.normalize(). 🧬

pathexists