https://github.com/aurbano/resource-path
:link: Tiny module to generate /resource/:paths for APIs
https://github.com/aurbano/resource-path
javascript npm-package url
Last synced: about 1 month ago
JSON representation
:link: Tiny module to generate /resource/:paths for APIs
- Host: GitHub
- URL: https://github.com/aurbano/resource-path
- Owner: aurbano
- License: mit
- Created: 2016-12-07T09:47:02.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-14T13:48:46.000Z (over 8 years ago)
- Last Synced: 2025-08-05T13:11:31.230Z (2 months ago)
- Topics: javascript, npm-package, url
- Language: JavaScript
- Homepage: https://aurbano.github.io/resource-path/
- Size: 65.4 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `/resource/:path`
[](https://travis-ci.org/aurbano/resource-path)
[](https://www.npmjs.com/package/resource-path)
[](https://coveralls.io/github/aurbano/resource-path?branch=master)
[](https://www.npmjs.com/package/resource-path)
[](https://www.npmjs.com/package/resource-path)
> Tiny module to generate resource paths for APIs, with zero dependencies
This module implements Angular's resource URL definition, so that you can easily interact with an API.
Example:
```js
import resource from 'resource-path';
const input = '/path/to/resource/:id';
const params = {
id: 123
};
resource(input, params);
// Returns: /path/to/resource/123
```
```js
const input = '/path/to/resource/:id/something/:param2';
const params = {
id: 123
};
resource(input, params);
// Returns: /path/to/resource/123
```
## Getting started
Install:
```bash
npm install --save resource-path
# or if you prefer yarn
yarn add resource-path
```
Usage
```js
import resource from 'resource-path';
resource(path, [params]);
```
* `path` `{string}` Is the path to the resource. Either a full URL or a relative path. It can contain identifiers in the form of `:identifier` in any part of the path.
* `params` `{Object}` An object with key/value pairs, where the keys are identifiers in the path, and the value is what will be replaced in it.
The `resource` method will return the path, substituting the params whenever if finds an indentifier. As soon as it finds an identifier without a specified parameter it stops.This way you can define full API paths that are reusable.
## Testing
Tests are located in the `tests` folder, and are written with `ava`.
## Contributing
Feel free to send any PR with new features, more test cases...
## License
This project is licensed under the MIT License.
[](https://github.com/aurbano)