aurelia-path/doc/api.json

Utilities for path manipulation.

{"id":0,"name":"aurelia-path","variant":"project","kind":1,"flags":{},"children":[{"id":9,"name":"buildQueryString","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"index.ts","line":162,"character":16,"url":"https://github.com/aurelia/path/blob/919e13412722f6fb05e4d26254651495e41fa8e1/src/index.ts#L162"}],"signatures":[{"id":10,"name":"buildQueryString","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Generate a query string from an object."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"The generated query string, excluding leading '?'."}]}]},"sources":[{"fileName":"index.ts","line":162,"character":16,"url":"https://github.com/aurelia/path/blob/919e13412722f6fb05e4d26254651495e41fa8e1/src/index.ts#L162"}],"parameters":[{"id":11,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Object containing the keys and values to be used."}]},"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Object"},"name":"Object","package":"typescript"}},{"id":12,"name":"traditional","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Boolean Use the old URI template standard (RFC6570)"}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"string"}}]},{"id":5,"name":"join","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"index.ts","line":56,"character":16,"url":"https://github.com/aurelia/path/blob/919e13412722f6fb05e4d26254651495e41fa8e1/src/index.ts#L56"}],"signatures":[{"id":6,"name":"join","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Joins two paths."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"The joined path."}]}]},"sources":[{"fileName":"index.ts","line":56,"character":16,"url":"https://github.com/aurelia/path/blob/919e13412722f6fb05e4d26254651495e41fa8e1/src/index.ts#L56"}],"parameters":[{"id":7,"name":"path1","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The first path."}]},"type":{"type":"intrinsic","name":"string"}},{"id":8,"name":"path2","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The second path."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}]},{"id":13,"name":"parseQueryString","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"index.ts","line":231,"character":16,"url":"https://github.com/aurelia/path/blob/919e13412722f6fb05e4d26254651495e41fa8e1/src/index.ts#L231"}],"signatures":[{"id":14,"name":"parseQueryString","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Parse a query string."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Object with keys and values mapped from the query string."}]}]},"sources":[{"fileName":"index.ts","line":231,"character":16,"url":"https://github.com/aurelia/path/blob/919e13412722f6fb05e4d26254651495e41fa8e1/src/index.ts#L231"}],"parameters":[{"id":15,"name":"queryString","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The query string to parse."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Object"},"name":"Object","package":"typescript"}}]},{"id":1,"name":"relativeToFile","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"index.ts","line":30,"character":16,"url":"https://github.com/aurelia/path/blob/919e13412722f6fb05e4d26254651495e41fa8e1/src/index.ts#L30"}],"signatures":[{"id":2,"name":"relativeToFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Calculates a path relative to a file."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"The calculated path."}]}]},"sources":[{"fileName":"index.ts","line":30,"character":16,"url":"https://github.com/aurelia/path/blob/919e13412722f6fb05e4d26254651495e41fa8e1/src/index.ts#L30"}],"parameters":[{"id":3,"name":"name","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The relative path."}]},"type":{"type":"intrinsic","name":"string"}},{"id":4,"name":"file","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The file path."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}]}],"groups":[{"title":"Functions","children":[9,5,13,1]}],"packageName":"aurelia-path","readme":[{"kind":"text","text":"# aurelia-path\n\n[![npm Version](https://img.shields.io/npm/v/aurelia-path.svg)](https://www.npmjs.com/package/aurelia-path)\n[![Discord Chat](https://img.shields.io/discord/448698263508615178.svg)](https://discord.gg/RBtyM6u)\n[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/aurelia/path)\n\nThis library is part of the [Aurelia](http://www.aurelia.io/) platform and contains utilities for path manipulation.\n\n> To keep up to date on [Aurelia](http://www.aurelia.io/), please visit and subscribe to [the official blog](http://blog.aurelia.io/) and [our email list](http://eepurl.com/ces50j). We also invite you to [follow us on twitter](https://twitter.com/aureliaeffect). If you have questions, please [join our community on Discord](https://discord.gg/RBtyM6u) or use [stack overflow](http://stackoverflow.com/search?q=aurelia). Documentation can be found [in our developer hub](http://aurelia.io/hub.html).\n\n## Platform Support\n\nThis library can be used in the **browser** as well as on the **server**.\n\n## Building The Code\n\nTo build the code, follow these steps.\n\n1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.\n2. From the project folder, execute the following command:\n\n  "},{"kind":"code","text":"```shell\n  npm ci\n  ```"},{"kind":"text","text":"\n3. To build the code, you can now run:\n\n  "},{"kind":"code","text":"```shell\n  npm run build\n  ```"},{"kind":"text","text":"\n5. You will find the compiled code in the "},{"kind":"code","text":"`dist`"},{"kind":"text","text":" folder, available in three module formats: AMD, CommonJS and ES6.\n\n## Running The Tests\n\nTo run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:\n\n1. You can now run the tests with this command:\n\n  "},{"kind":"code","text":"```shell\n  npm test\n  ```"}],"symbolIdMap":{"0":{"sourceFileName":"src/index.ts","qualifiedName":""},"1":{"sourceFileName":"src/index.ts","qualifiedName":"relativeToFile"},"2":{"sourceFileName":"src/index.ts","qualifiedName":"relativeToFile"},"3":{"sourceFileName":"src/index.ts","qualifiedName":"name"},"4":{"sourceFileName":"src/index.ts","qualifiedName":"file"},"5":{"sourceFileName":"src/index.ts","qualifiedName":"join"},"6":{"sourceFileName":"src/index.ts","qualifiedName":"join"},"7":{"sourceFileName":"src/index.ts","qualifiedName":"path1"},"8":{"sourceFileName":"src/index.ts","qualifiedName":"path2"},"9":{"sourceFileName":"src/index.ts","qualifiedName":"buildQueryString"},"10":{"sourceFileName":"src/index.ts","qualifiedName":"buildQueryString"},"11":{"sourceFileName":"src/index.ts","qualifiedName":"params"},"12":{"sourceFileName":"src/index.ts","qualifiedName":"traditional"},"13":{"sourceFileName":"src/index.ts","qualifiedName":"parseQueryString"},"14":{"sourceFileName":"src/index.ts","qualifiedName":"parseQueryString"},"15":{"sourceFileName":"src/index.ts","qualifiedName":"queryString"}},"files":{"entries":{"1":"src/index.ts"},"reflections":{"1":0}}}