Logo for jsDocs.io

aurelia-path

  • Version 1.1.8
  • Published
  • 109 kB
  • No dependencies
  • MIT license

Install

npm i aurelia-path
yarn add aurelia-path
pnpm add aurelia-path

Overview

Utilities for path manipulation.

Index

Functions

Functions

function buildQueryString

buildQueryString: (params?: Object, traditional?: boolean) => string;

  • Generate a query string from an object.

    Parameter params

    Object containing the keys and values to be used.

    Parameter traditional

    Boolean Use the old URI template standard (RFC6570)

    Returns

    The generated query string, excluding leading '?'.

function join

join: (path1: string, path2: string) => string;

  • Joins two paths.

    Parameter path1

    The first path.

    Parameter path2

    The second path. The joined path.

function parseQueryString

parseQueryString: (queryString: string) => Object;

  • Parse a query string.

    Parameter queryString

    The query string to parse.

    Returns

    Object with keys and values mapped from the query string.

function relativeToFile

relativeToFile: (name: string, file: string) => string;

  • Calculates a path relative to a file.

    Parameter name

    The relative path.

    Parameter file

    The file path. The calculated path.

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (11)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/aurelia-path.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/aurelia-path)
  • HTML
    <a href="https://www.jsdocs.io/package/aurelia-path"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>