# vorlefan.path_route

> Easily access and manage the folder and files of your project

Latest version **1.2.2** (published 2019-12-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install vorlefan.path_route
pnpm add vorlefan.path_route
yarn add vorlefan.path_route
bun add vorlefan.path_route
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2019-12-12 |
| First published | 2019-11-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 39.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Michael Willian Santos |
| Maintainers | vorlefan |
| Keywords | path, routes, files, folder, tree |

## Links

- npm: https://www.npmjs.com/package/vorlefan.path_route
- Homepage: https://github.com/DaxSoft/path_route
- npm.io page: https://npm.io/package/vorlefan.path_route

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.2.2 (latest) — 2019-12-12
- 1.2.1 — 2019-11-28
- 1.2.0 — 2019-11-27
- 1.1.5 — 2019-11-26
- 1.1.4 — 2019-11-26
- 1.1.3 — 2019-11-24
- 1.1.21 — 2019-11-23
- 1.1.2 — 2019-11-23
- 1.1.1 — 2019-11-22
- 1.1.0 — 2019-11-22
- 0.3.4 — 2019-11-22

## README

# Path Route 
This is my first npm package module. The main function is to give the power of easily accessing the folders and files of your project.

With [npm](https://npmjs.org) do:

```
npm install vorlefan.path_route
```

With [yarn](https://yarnpkg.com/en/) do:

```
yarn add vorlefan.path_route
```

<hr>
  
### Documentation

You can access on the folder 'docs' of this repository 
A better documentation will be made at the near future.
  
<hr>

### Highlight
- Create several custom routes to access different folders & files
- Without any dependency
- Manage your files with the power to read and store
- Easy to use

<hr>

### Example

Please, take a look at the 'example' folder of this repository

``` js
 'use strict';

/**
 * @description Basic usage of this module. 
 * This will take at account this folder (module folder),
 * as example.
 */


const {
    Routes,
    Route
} = require('../index')


// Create a new route instance and give it a name

Routes.instance((instance) => {

    instance.set('src', instance.resolve(__dirname, '..'))
    instance.join('test', 'src')
    instance.join('examples', 'src')

}).namespace("Basic")


// Access

console.log(Route.Basic.get('test'));
console.log(Route.Basic.get('examples').path);
```

---
_Source: https://npm.io/package/vorlefan.path_route · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._