Package Exports

path-slashes
path-slashes/dist/path-slashes.js

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 (path-slashes) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Path Slashes

A javascript library to add or remove trailing and/or leading slashes in path strings, test for their existence or join path strings with slashes without duplicating them.

Install

This package is published to the npm registry as path-slahes.

You can install it:

# using npm:
npm install --save path-slashes

# using yarn:
yarn add path-slashes

ℹ️ HINT: This library is a pure ESM package. (You may want to read this.)

Usage Examples

import { hasLeadingSlash } from 'path-slashes';

// Check if given path has a leading slash
hasLeadingSlash('/foo'); // -> true
hasLeadingSlash('foo'); // -> false

import { hasTrailingSlash } from 'path-slashes';

// Check if given path has a trailing slash
hasTrailingSlash('foo/'); // -> true
hasTrailingSlash('foo'); // -> false

import { withLeadingSlash } from 'path-slashes';

// Ensure given path has a leading slash
withLeadingSlash('foo'); // -> '/foo'

import { withTrailingSlash } from 'path-slashes';

// Ensure given path has a trailing slash
withTrailingSlash('foo'); // -> 'foo/'

import { withoutLeadingSlash } from 'path-slashes';

// Ensure given path has no leading slash
withoutLeadingSlash('/foo/'); // -> 'foo/'

import { withoutTrailingSlash } from 'path-slashes';

// Ensure given path has no trailing slash
withoutTrailingSlash('/foo/'); // -> '/foo'

import { withSlashes } from 'path-slashes';

// Ensure given path has both leading and trailing slashes
withSlashes('foo'); // -> '/foo/'

import { withoutSlashes } from 'path-slashes';

// Ensure given path has neither leading nor trailing slashes
withoutSlashes('/foo/'); // -> 'foo'

import { slashJoin } from 'path-slashes';

// Join path parts and add slashes where necessary
slashJoin('foo', 'bar/', '/baz'); // -> 'foo/bar/baz'

API

function hasLeadingSlash(path: string): boolean;

function hasTrailingSlash(path: string): boolean;

function withLeadingSlash(path: string): string;

function withTrailingSlash(path: string): string;

function withSlashes(path: string): string;

function withoutLeadingSlash(path: string): string;

function withoutTrailingSlash(path: string): string;

function withoutSlashes(path: string): string;

function slashJoin(...strings: (string | string[])[]): string;

path-slashes

Package Exports

Readme

Path Slashes

Install

Usage Examples

API

License and Author