UNPKG

@overlook/plugin-request

Version:

Overlook framework request plugin

github.com/overlookjs/plugin-request

overlookjs/plugin-request

49 lines (29 loc) • 2.68 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
[![NPM version](https://img.shields.io/npm/v/@overlook/plugin-request.svg)](https://www.npmjs.com/package/@overlook/plugin-request) [![Build Status](https://img.shields.io/travis/overlookjs/plugin-request/master.svg)](http://travis-ci.org/overlookjs/plugin-request) [![Dependency Status](https://img.shields.io/david/overlookjs/plugin-request.svg)](https://david-dm.org/overlookjs/plugin-request) [![Dev dependency Status](https://img.shields.io/david/dev/overlookjs/plugin-request.svg)](https://david-dm.org/overlookjs/plugin-request) [![Greenkeeper badge](https://badges.greenkeeper.io/overlookjs/plugin-request.svg)](https://greenkeeper.io/) [![Coverage Status](https://img.shields.io/coveralls/overlookjs/plugin-request/master.svg)](https://coveralls.io/r/overlookjs/plugin-request) # Overlook framework request plugin Part of the [Overlook framework](https://overlookjs.github.io/). ## Usage This plugin exports two symbols, which are used as the most basic properties of Overlook request objects: * `[REQ_TYPE]` * `[PATH]` For example, [@overlook/plugin-serve-http](https://www.npmjs.com/package/@overlook/plugin-serve-http) sets `req[REQ_TYPE]` to `'HTTP'` and records the request path as `req[PATH]`. This plugin should not actually be used as a plugin - `Route.extend( requestPlugin )` adds no methods to the Route and so is pointless. This "plugin" only exists to export symbols. ## Versioning This module follows [semver](https://semver.org/). Breaking changes will only be made in major version updates. All active NodeJS release lines are supported (v10+ at time of writing). After a release line of NodeJS reaches end of life according to [Node's LTS schedule](https://nodejs.org/en/about/releases/), support for that version of Node may be dropped at any time, and this will not be considered a breaking change. Dropping support for a Node version will be made in a minor version update (e.g. 1.2.0 to 1.3.0). If you are using a Node version which is approaching end of life, pin your dependency of this module to patch updates only using tilde (`~`) e.g. `~1.2.3` to avoid breakages. ## Tests Use `npm test` to run the tests. Use `npm run cover` to check coverage. ## Changelog See [changelog.md](https://github.com/overlookjs/plugin-request/blob/master/changelog.md) ## Issues If you discover a bug, please raise an issue on Github. https://github.com/overlookjs/plugin-request/issues ## Contribution Pull requests are very welcome. Please: * ensure all tests pass before submitting PR * add tests for new features * document new functionality/API additions in README * do not add an entry to Changelog (Changelog is created when cutting releases)