Gathering detailed insights and metrics for @ffras4vnpm/occaecati-accusantium-quisquam
Gathering detailed insights and metrics for @ffras4vnpm/occaecati-accusantium-quisquam
Installations
npm install @ffras4vnpm/occaecati-accusantium-quisquamDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
20.12.2
NPM Version
10.5.0
Releases
Unable to fetch releases
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
Maintainers
1
Package Meta Information
Latest Version
1.0.0
Package Id
@ffras4vnpm/occaecati-accusantium-quisquam@1.0.0
Unpacked Size
16.46 kB
Size
6.42 kB
File Count
10
NPM Version
10.5.0
Node Version
20.12.2
Published on
Apr 26, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
33
@diahkomalasarinpm/dolore-aliquam-suscipit@f1stnpm2/odio-illo-aut@ffras4vnpm/ab-doloribus-velit-assumenda@ffras4vnpm/accusamus-animi-fuga-sit@ffras4vnpm/amet-delectus-repellat-itaque@ffras4vnpm/atque-odio-ipsam-unde@ffras4vnpm/blanditiis-alias-distinctio-veniam@ffras4vnpm/commodi-voluptas-aliquam-eius@ffras4vnpm/corrupti-modi-porro-provident@ffras4vnpm/deleniti-nemo-nam-optio@ffras4vnpm/dicta-iure-veniam-reprehenderit@ffras4vnpm/dolor-est-blanditiis-odit@ffras4vnpm/dolorum-mollitia-enim-non@ffras4vnpm/dolorum-nemo-laudantium-corporis@ffras4vnpm/esse-est-similique-at@ffras4vnpm/exercitationem-officia-id-ea@ffras4vnpm/explicabo-neque-nobis-impedit@ffras4vnpm/fugit-magnam-modi-dignissimos@ffras4vnpm/illo-laboriosam-sed-ipsa@ffras4vnpm/iste-quo-reiciendis-debitis@ffras4vnpm/neque-accusamus-cum-maxime@ffras4vnpm/neque-ad-sit-velit@ffras4vnpm/nostrum-ad-quia-perspiciatis@ffras4vnpm/omnis-sunt-occaecati-saepe@ffras4vnpm/placeat-corrupti-nobis-velit@ffras4vnpm/repudiandae-deserunt-earum-quos@ffras4vnpm/repudiandae-nulla-velit-recusandae@ffras4vnpm/sit-inventore-dignissimos-repellendus@ffras4vnpm/soluta-inventore-nam-harum@ffras4vnpm/ut-quos-aut-quod@ffras4vnpm/vitae-incidunt-nostrum-dolore@ffras4vnpm/voluptates-laudantium-eum-natus@wemnyelezxnpm/provident-quae-accusamus
@ffras4vnpm/occaecati-accusantium-quisquam
@ffras4vnpm/occaecati-accusantium-quisquam is a routing utility allowing to map a path to a value
@ffras4vnpm/occaecati-accusantium-quisquam stands for "Shit In Shit Out". It allows to build
routers without embedding a framework and falling
into the gorilla banana problem ;).
It also match the French "ciseau" word pronunciation which means "chisel".
The parameters definition somewhat matches the Swagger one so that you will be able to use Siso with your swagger definition easily.
Usage
The @ffras4vnpm/occaecati-accusantium-quisquam concept is pretty simple. You associate paths
patterns to values, then you pass a path in and get values
and parameters out. And that's it, fair enough ;).
@ffras4vnpm/occaecati-accusantium-quisquam does not decide which separator is used for your
paths so that you can use it for any routing concern.
1import { Siso } from @ffras4vnpm/occaecati-accusantium-quisquam; 2 3const @ffras4vnpm/occaecati-accusantium-quisquam = new Siso(); 4 5// Associate the '/v1/users' path to the 'user.list' value 6@ffras4vnpm/occaecati-accusantium-quisquam.register([ 7 'v1', 8 'users', 9], 'user.list'); 10 11// Associate the '/v1/users/:id' path to the 'user.detail' value 12@ffras4vnpm/occaecati-accusantium-quisquam.register([ 13 'v1', 14 'users', 15 { 16 name: 'id', 17 type: 'number', 18 pattern: /^[0-9]+$/, 19 }, 20], 'user.detail'); 21 22// Find a value for /v1/users/12 23@ffras4vnpm/occaecati-accusantium-quisquam.find(['v1', 'users', '12']); 24// Returns: ['user.detail', {id: 12}]
Note that you can provide any value for a given path. It may be a function, an array, an object or a string depending of your needs.
Despite its simplicity, @ffras4vnpm/occaecati-accusantium-quisquam is very opinionated since
it won't allow you to define several values for the
same path pattern and will throw if such situation happens.
It is very different from the kind of routing systems you probably used before. Frameworks like Express would allow registering several middlewares for the same path, for instance.
My opinion is that it is a bad thing. Every route should have a single handler and higher order functions should be used instead. That way, you have the overhaul workflow of each route in their own controllers. No magic, no need to guess what happens before/after the route handler. Read my blog post on this concern.
@ffras4vnpm/occaecati-accusantium-quisquam is just a building block, if you need a higher
level way to deal with routers see
swagger-http-router.
API
Siso
Siso
Kind: global class
- Siso
- new Siso()
- .register(pathPatternNodes, value) ⇒
void - .find(pathNodes) ⇒
void
new Siso()
Create a new Siso instance
Returns: Siso - The Siso instance
Example
1import { Siso } from '@ffras4vnpm/occaecati-accusantium-quisquam'; 2 3const @ffras4vnpm/occaecati-accusantium-quisquam = new Siso();
@ffras4vnpm/occaecati-accusantium-quisquam.register(pathPatternNodes, value) ⇒ void
Register a value for a pattern path
Kind: instance method of Siso
| Param | Type | Description |
|---|---|---|
| pathPatternNodes | Array | The various nodes of the path pattern |
| value | any | The value registered for the given path pattern |
Example
1import { Siso } from '@ffras4vnpm/occaecati-accusantium-quisquam'; 2 3const @ffras4vnpm/occaecati-accusantium-quisquam = new Siso(); 4 5// Path pattern nodes may be simple strings 6@ffras4vnpm/occaecati-accusantium-quisquam.register(['v1', 'users'], 'user.list'); 7 8// Or parameters with a name and its corresponding node pattern 9@ffras4vnpm/occaecati-accusantium-quisquam.register([ 10 'v1', 11 'users', 12 { name: 'id', pattern: /[a-f0-9]{24}/, type: 'string' }, 13], 'user.details');
@ffras4vnpm/occaecati-accusantium-quisquam.find(pathNodes) ⇒ void
Find the value for the given path
Kind: instance method of Siso
| Param | Type | Description |
|---|---|---|
| pathNodes | Array | The path nodes for which to look for a value |
Example
1import { Siso } from '@ffras4vnpm/occaecati-accusantium-quisquam'; 2 3const @ffras4vnpm/occaecati-accusantium-quisquam = new Siso(); 4 5@ffras4vnpm/occaecati-accusantium-quisquam.register([ 6 'v1', 7 'users', 8 { name: 'userId', pattern: /[a-f0-9]{24}/, type: 'string' }, 9], 'anotherValue'); 10 11@ffras4vnpm/occaecati-accusantium-quisquam.find(['v1', 'users', 'abbacacaabbacacaabbacaca']); 12// ['anotherValue', { userId: 'abbacacaabbacacaabbacaca' }]
Authors
License
No vulnerabilities found.
No security vulnerabilities found.