install @octokit/rest
This commit is contained in:
1 parent
39d9c0de99
commit
e44c6cb357
1145 files changed
+67878
-1
No files matched your search
Binary file not shown.
+22
@@ -0,0 +1,22 @@
|
||||
The MIT License
|
||||
|
||||
Copyright (c) 2012 Cloud9 IDE, Inc. (Mike de Boer)
|
||||
Copyright (c) 2017 Octokit contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
+166
@@ -0,0 +1,166 @@
|
||||
# rest.js
|
||||
|
||||
> GitHub REST API client for Node.js
|
||||
|
||||
[](https://travis-ci.org/octokit/rest.js)
|
||||
[](https://coveralls.io/github/octokit/rest.js)
|
||||
[](https://greenkeeper.io/)
|
||||
[](https://www.npmjs.com/package/@octokit/rest)
|
||||
|
||||
## Usage
|
||||
|
||||
Install with `npm install @octokit/rest`.
|
||||
|
||||
<!-- HEADS UP: when changing the options for the constructor, make sure to also
|
||||
update the type definition templates in scripts/templates/* -->
|
||||
```js
|
||||
const octokit = require('@octokit/rest')()
|
||||
|
||||
// Compare: https://developer.github.com/v3/repos/#list-organization-repositories
|
||||
octokit.repos.getForOrg({
|
||||
org: 'octokit',
|
||||
type: 'public'
|
||||
}).then(({data}) => {
|
||||
// handle data
|
||||
})
|
||||
```
|
||||
|
||||
All available client options with default values
|
||||
|
||||
```js
|
||||
const octokit = require('@octokit/rest')({
|
||||
timeout: 0, // 0 means no request timeout
|
||||
requestMedia: 'application/vnd.github.v3+json',
|
||||
headers: {
|
||||
'user-agent': 'octokit/rest.js v1.2.3' // v1.2.3 will be current version
|
||||
},
|
||||
|
||||
// change for custom GitHub Enterprise URL
|
||||
host: 'api.github.com',
|
||||
pathPrefix: '',
|
||||
protocol: 'https',
|
||||
port: 433,
|
||||
|
||||
// advanced request options
|
||||
// see https://nodejs.org/api/http.html
|
||||
proxy: undefined,
|
||||
ca: undefined,
|
||||
rejectUnauthorized: undefined,
|
||||
family: undefined
|
||||
})
|
||||
```
|
||||
|
||||
`@octokit/rest` API docs: https://octokit.github.io/rest.js/
|
||||
GitHub v3 REST API docs: https://developer.github.com/v3/
|
||||
|
||||
## Authentication
|
||||
|
||||
Most GitHub API calls don't require authentication. Rules of thumb:
|
||||
|
||||
1. If you can see the information by visiting the site without being logged in, you don't have to be authenticated to retrieve the same information through the API.
|
||||
2. If you want to change data, you have to be authenticated.
|
||||
|
||||
```javascript
|
||||
// basic
|
||||
octokit.authenticate({
|
||||
type: 'basic',
|
||||
username: 'yourusername',
|
||||
password: 'password'
|
||||
})
|
||||
|
||||
// oauth
|
||||
octokit.authenticate({
|
||||
type: 'oauth',
|
||||
token: 'secrettoken123'
|
||||
})
|
||||
|
||||
// oauth key/secret (to get a token)
|
||||
octokit.authenticate({
|
||||
type: 'oauth',
|
||||
key: 'client_id',
|
||||
secret: 'client_secret'
|
||||
})
|
||||
|
||||
// token (https://github.com/settings/tokens)
|
||||
octokit.authenticate({
|
||||
type: 'token',
|
||||
token: 'secrettoken123'
|
||||
})
|
||||
|
||||
// GitHub app
|
||||
octokit.authenticate({
|
||||
type: 'integration',
|
||||
token: 'secrettoken123'
|
||||
})
|
||||
```
|
||||
|
||||
Note: `authenticate` is synchronous because it only sets the credentials
|
||||
for the following requests.
|
||||
|
||||
## Pagination
|
||||
|
||||
There are a few pagination-related methods:
|
||||
|
||||
- `hasNextPage(response)`
|
||||
- `hasPreviousPage(response)`
|
||||
- `hasFirstPage(response)`
|
||||
- `hasLastPage(response)`
|
||||
- `getNextPage(response)`
|
||||
- `getPreviousPage(response)`
|
||||
- `getFirstPage(response)`
|
||||
- `getLastPage(response)`
|
||||
|
||||
Usage
|
||||
|
||||
```js
|
||||
async function paginate (method) {
|
||||
let response = await method({per_page: 100})
|
||||
let {data} = response
|
||||
while (octokit.hasNextPage(response)) {
|
||||
response = await octokit.getNextPage(response)
|
||||
data = data.concat(response.data)
|
||||
}
|
||||
return data
|
||||
}
|
||||
|
||||
paginate(octokit.repos.getAll)
|
||||
.then(data => {
|
||||
// handle all results
|
||||
})
|
||||
```
|
||||
|
||||
## DEBUG
|
||||
|
||||
Set `DEBUG=octokit:rest*` for additional debug logs.
|
||||
|
||||
## Tests
|
||||
|
||||
Run all tests
|
||||
|
||||
```bash
|
||||
$ npm test
|
||||
```
|
||||
|
||||
Or run a specific test
|
||||
|
||||
```bash
|
||||
$ ./node_modules/.bin/mocha test/test/integration/get-repository-test.js
|
||||
```
|
||||
|
||||
The examples are run as part of the tests. You can set an `EXAMPLES_GITHUB_TOKEN` environment
|
||||
variable (or set it in a `.env` file) to avoid running against GitHub's rate limit.
|
||||
|
||||
## Contributing
|
||||
|
||||
We would love you to contribute to `@octokit/rest`, pull requests are very welcomed!
|
||||
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
|
||||
|
||||
## Credits
|
||||
|
||||
`@octokit/rest` was originally created as [`node-github`](https://www.npmjs.com/package/github)
|
||||
in 2012 by Mike de Boer from Cloud9 IDE, Inc.
|
||||
It was adopted and renamed by GitHub in 2017
|
||||
|
||||
## LICENSE
|
||||
|
||||
[MIT](LICENSE)
|
||||
+3475
File diff suppressed because it is too large.
Load diff
+31
@@ -0,0 +1,31 @@
|
||||
module.exports = GitHubApi
|
||||
|
||||
const defaultsDeep = require('lodash/defaultsDeep')
|
||||
const Hook = require('before-after-hook')
|
||||
|
||||
const parseClientOptions = require('./lib/parse-client-options')
|
||||
const request = require('./lib/request')
|
||||
const ENDPOINT_DEFAULTS = require('./lib/endpoint').DEFAULTS
|
||||
|
||||
const PLUGINS = [
|
||||
require('./lib/plugins/authentication'),
|
||||
require('./lib/plugins/endpoint-methods'),
|
||||
require('./lib/plugins/pagination')
|
||||
]
|
||||
|
||||
function GitHubApi (options) {
|
||||
const defaults = defaultsDeep(parseClientOptions(options), ENDPOINT_DEFAULTS)
|
||||
|
||||
const hook = new Hook()
|
||||
const api = {
|
||||
// NOTE: github.hook, github.plugin and github.request are experimental APIs
|
||||
// at this point and can change at any time
|
||||
hook,
|
||||
plugin: (pluginFunction) => pluginFunction(api),
|
||||
request: (options) => api.hook('request', defaultsDeep(options, defaults), request)
|
||||
}
|
||||
|
||||
PLUGINS.forEach(api.plugin)
|
||||
|
||||
return api
|
||||
}
|
||||
+3441
File diff suppressed because it is too large.
Load diff
+13
@@ -0,0 +1,13 @@
|
||||
module.exports = {
|
||||
ca: undefined,
|
||||
family: undefined, // 4 for v4, 6 for v6
|
||||
headers: {},
|
||||
host: 'api.github.com',
|
||||
pathPrefix: '', // for GitHub Enterprise
|
||||
port: undefined,
|
||||
protocol: 'https',
|
||||
proxy: undefined,
|
||||
rejectUnauthorized: true,
|
||||
requestMedia: 'application/vnd.github.v3+json',
|
||||
timeout: 0
|
||||
}
|
||||
+69
@@ -0,0 +1,69 @@
|
||||
[back to `@octokit/rest`]('../..')
|
||||
|
||||
# `@octokit/rest/endpoint`
|
||||
|
||||
> Turn REST API endpoint options into generic request options
|
||||
|
||||
---
|
||||
|
||||
# ⚠️ This is not a public API at this point and can change at any time
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const octokitRestEndpoint = require('@octokit/rest/lib/endpoint')
|
||||
|
||||
const options = octokitRestEndpoint({
|
||||
// request options
|
||||
method: 'GET',
|
||||
url: '/orgs/:org/repos',
|
||||
// parameters
|
||||
org: 'octokit',
|
||||
type: 'private'
|
||||
})
|
||||
```
|
||||
|
||||
`options` would now look something like
|
||||
|
||||
```js
|
||||
{
|
||||
method: 'GET',
|
||||
url: 'https://api.github.com/orgs/octokit/repos?type=private',
|
||||
headers: {
|
||||
'user-agent': 'octokit/rest.js v1.2.3',
|
||||
accept: 'application/vnd.github.v3+json'
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
You can pass them to your request library of preference.
|
||||
|
||||
## Options
|
||||
|
||||
### `method`
|
||||
|
||||
Any supported [http verb](https://developer.github.com/v3/#http-verbs), case insensitive.
|
||||
|
||||
### `url`
|
||||
|
||||
A path or full URL which may contain `:variable` or `{variable}` placeholders,
|
||||
e.g. `/orgs/:org/repos`. The `url` is parsed using
|
||||
|
||||
## Defaults
|
||||
|
||||
| Name | Value |
|
||||
|------------------------|-------------------------------------------------------------------------------------|
|
||||
| **method** | `'get'` |
|
||||
| **baseUrl** | `'https://api.github.com'` |
|
||||
| **headers.accept** | `'application/vnd.github.v3+json'` |
|
||||
| **headers.user-agent** | `'octokit/rest.js v1.2.3'` (1.2.3 being the current `@octokit.rest` version number) |
|
||||
|
||||
_To be done_: change defaults with
|
||||
|
||||
```js
|
||||
const octokitRestEndpoint = require('@octokit/rest/lib/endpoint').defaults({
|
||||
baseUrl: 'http://my-custom-host/api/v3'
|
||||
})
|
||||
```
|
||||
+22
@@ -0,0 +1,22 @@
|
||||
module.exports = addQueryParameters
|
||||
|
||||
function addQueryParameters (url, parameters) {
|
||||
const separator = /\?/.test(url) ? '&' : '?'
|
||||
const names = Object.keys(parameters)
|
||||
|
||||
if (names.length === 0) {
|
||||
return url
|
||||
}
|
||||
|
||||
return url + separator + names
|
||||
.map(name => {
|
||||
if (name === 'q') {
|
||||
return 'q=' + parameters.q.split('+')
|
||||
.map(encodeURIComponent)
|
||||
.join('+')
|
||||
}
|
||||
|
||||
return `${name}=${encodeURIComponent(parameters[name])}`
|
||||
})
|
||||
.join('&')
|
||||
}
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
const pkg = require('../../package.json')
|
||||
|
||||
module.exports = {
|
||||
method: 'get',
|
||||
baseUrl: 'https://api.github.com',
|
||||
headers: {
|
||||
accept: 'application/vnd.github.v3+json',
|
||||
'user-agent': `octokit/rest.js v${pkg.version}`
|
||||
},
|
||||
request: {}
|
||||
}
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
module.exports = extractUrlVariableName
|
||||
|
||||
const _ = require('lodash')
|
||||
|
||||
const urlVariableRegex = /\{[^}]+\}/g
|
||||
function extractUrlVariableName (url) {
|
||||
const matches = url.match(urlVariableRegex)
|
||||
|
||||
if (!matches) {
|
||||
return []
|
||||
}
|
||||
|
||||
return _.flatten(matches.map(removeNonChars))
|
||||
}
|
||||
|
||||
function removeNonChars (variableName) {
|
||||
return variableName.replace(/^\W+|\W+$/g, '').split(/,/)
|
||||
}
|
||||
+60
@@ -0,0 +1,60 @@
|
||||
'use strict'
|
||||
|
||||
module.exports = restEndpoint
|
||||
|
||||
const _ = require('lodash')
|
||||
const urlTemplate = require('url-template')
|
||||
|
||||
const addQueryParameters = require('./add-query-parameters')
|
||||
const extractUrlVariableNames = require('./extract-url-variable-names')
|
||||
|
||||
const DEFAULTS = module.exports.DEFAULTS = require('./defaults')
|
||||
const NON_PARAMETERS = [
|
||||
'request',
|
||||
'baseUrl'
|
||||
]
|
||||
|
||||
function restEndpoint (options) {
|
||||
options = _.defaultsDeep({}, options, DEFAULTS)
|
||||
let method = options.method
|
||||
let baseUrl = options.baseUrl
|
||||
let url = options.url
|
||||
let body = options.body
|
||||
let headers = options.headers
|
||||
let remainingOptions = _.omit(options, ['method', 'baseUrl', 'url', 'headers'])
|
||||
|
||||
method = method.toLowerCase()
|
||||
headers = _.mapKeys(headers, (value, key) => key.toLowerCase())
|
||||
|
||||
// replace :varname with {varname} to make it RFC 6570 compatible
|
||||
url = url.replace(/:(\w+)/g, '{+$1}')
|
||||
|
||||
// extract variable names from URL to calculate remaining variables later
|
||||
const urlVariableNames = extractUrlVariableNames(url)
|
||||
|
||||
url = urlTemplate.parse(url).expand(remainingOptions)
|
||||
|
||||
if (!/^http/.test(url)) {
|
||||
url = (baseUrl) + url
|
||||
}
|
||||
|
||||
const requestOptions = remainingOptions.request
|
||||
remainingOptions = _.omit(remainingOptions, _.intersection(Object.keys(options), urlVariableNames).concat(NON_PARAMETERS))
|
||||
|
||||
if (method === 'get' || method === 'head') {
|
||||
url = addQueryParameters(url, remainingOptions)
|
||||
} else {
|
||||
if ('input' in remainingOptions) {
|
||||
body = remainingOptions.input
|
||||
} else {
|
||||
body = Object.keys(remainingOptions).length ? remainingOptions : undefined
|
||||
}
|
||||
}
|
||||
|
||||
return Object.assign(requestOptions, {
|
||||
method,
|
||||
url,
|
||||
headers,
|
||||
body
|
||||
})
|
||||
}
|
||||
+58
@@ -0,0 +1,58 @@
|
||||
module.exports = parseOptions
|
||||
|
||||
const _ = require('lodash')
|
||||
|
||||
const DEFAULTS = require('./defaults')
|
||||
const OPTION_NAMES = [
|
||||
'timeout',
|
||||
'host',
|
||||
'pathPrefix',
|
||||
'protocol',
|
||||
'port',
|
||||
'proxy',
|
||||
'ca',
|
||||
'headers',
|
||||
'requestMedia',
|
||||
'rejectUnauthorized',
|
||||
'family'
|
||||
]
|
||||
|
||||
function parseOptions (options) {
|
||||
if (!options) {
|
||||
options = {}
|
||||
}
|
||||
|
||||
if ('followRedirects' in options) {
|
||||
console.warn('DEPRECATED: followRedirects option is no longer supported. All redirects are followed correctly')
|
||||
}
|
||||
|
||||
if ('Promise' in options) {
|
||||
console.warn('DEPRECATED: Promise option is no longer supported. The native Promise API is used')
|
||||
}
|
||||
|
||||
options = _.defaults(_.pick(options, OPTION_NAMES), DEFAULTS)
|
||||
|
||||
const defaults = {
|
||||
headers: options.headers,
|
||||
request: {
|
||||
ca: options.ca,
|
||||
family: options.family,
|
||||
proxy: options.proxy,
|
||||
rejectUnauthorized: options.rejectUnauthorized,
|
||||
timeout: options.timeout
|
||||
}
|
||||
}
|
||||
|
||||
defaults.baseUrl = `${options.protocol}://${options.host}`
|
||||
|
||||
if (options.port) {
|
||||
defaults.baseUrl += `:${options.port}`
|
||||
}
|
||||
|
||||
// Check if a prefix is passed in the options and strip any leading or trailing slashes from it.
|
||||
if (options.pathPrefix) {
|
||||
defaults.baseUrl += '/' + options.pathPrefix.replace(/(^[/]+|[/]+$)/g, '')
|
||||
}
|
||||
|
||||
return defaults
|
||||
}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
# `@octokit/plugins/*`
|
||||
|
||||
---
|
||||
|
||||
# ⚠️ Plugins are currently experimental. APIs can change at any time.
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const octokit = require('@octokit/rest')()
|
||||
|
||||
function myPlugin (octokit) {
|
||||
octokit.myMethod = function () {
|
||||
// ...
|
||||
}
|
||||
octokit.hook.before('request', (options) => {
|
||||
// change options or cancel request.
|
||||
// return promise for async methods
|
||||
})
|
||||
octokit.hook.after('request', (result, options) => {
|
||||
// ...
|
||||
})
|
||||
}
|
||||
|
||||
octokit.plugin(myPlugin)
|
||||
|
||||
octokit.myMethod()
|
||||
octokit.request({url: '/'}) // runs before/after hooks defined above
|
||||
```
|
||||
+34
@@ -0,0 +1,34 @@
|
||||
module.exports = authenticate
|
||||
|
||||
function authenticate (state, options) {
|
||||
if (!options) {
|
||||
state.auth = false
|
||||
return
|
||||
}
|
||||
|
||||
switch (options.type) {
|
||||
case 'basic':
|
||||
if (!options.username || !options.password) {
|
||||
throw new Error('Basic authentication requires both a username and password to be set')
|
||||
}
|
||||
break
|
||||
|
||||
case 'oauth':
|
||||
if (!options.token && !(options.key && options.secret)) {
|
||||
throw new Error('OAuth2 authentication requires a token or key & secret to be set')
|
||||
}
|
||||
break
|
||||
|
||||
case 'token':
|
||||
case 'integration':
|
||||
if (!options.token) {
|
||||
throw new Error('Token authentication requires a token to be set')
|
||||
}
|
||||
break
|
||||
|
||||
default:
|
||||
throw new Error("Invalid authentication type, must be 'basic', 'integration', or 'oauth'")
|
||||
}
|
||||
|
||||
state.auth = options
|
||||
}
|
||||
+37
@@ -0,0 +1,37 @@
|
||||
module.exports = authenticationBeforeRequest
|
||||
|
||||
function authenticationBeforeRequest (state, options) {
|
||||
if (!state.auth.type) {
|
||||
return
|
||||
}
|
||||
|
||||
if (state.auth.type === 'basic') {
|
||||
const hash = Buffer.from(
|
||||
`${state.auth.username}:${state.auth.password}`, 'ascii'
|
||||
).toString('base64')
|
||||
options.headers['authorization'] = `Basic ${hash}`
|
||||
return
|
||||
}
|
||||
|
||||
if (state.auth.type === 'token') {
|
||||
options.headers['authorization'] = `token ${state.auth.token}`
|
||||
return
|
||||
}
|
||||
|
||||
if (state.auth.type === 'integration') {
|
||||
options.headers['authorization'] = `Bearer ${state.auth.token}`
|
||||
options.headers['accept'] = 'application/vnd.github.machine-man-preview+json'
|
||||
return
|
||||
}
|
||||
|
||||
options.url += options.url.indexOf('?') === -1 ? '?' : '&'
|
||||
|
||||
if (state.auth.token) {
|
||||
options.url += `access_token=${encodeURIComponent(state.auth.token)}`
|
||||
return
|
||||
}
|
||||
|
||||
const key = encodeURIComponent(state.auth.key)
|
||||
const secret = encodeURIComponent(state.auth.secret)
|
||||
options.url += `client_id=${key}&client_secret=${secret}`
|
||||
}
|
||||
+12
@@ -0,0 +1,12 @@
|
||||
module.exports = authenticationPlugin
|
||||
|
||||
const authenticate = require('./authenticate')
|
||||
const beforeRequest = require('./before-request')
|
||||
|
||||
function authenticationPlugin (octokit) {
|
||||
const state = {
|
||||
auth: false
|
||||
}
|
||||
octokit.authenticate = authenticate.bind(null, state)
|
||||
octokit.hook.before('request', beforeRequest.bind(null, state))
|
||||
}
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
module.exports = deprecate
|
||||
|
||||
function deprecate (func, message) {
|
||||
return function () {
|
||||
const caller = (new Error()).stack.split('\n')[2]
|
||||
console.warn('DEPRECATED: ' + message)
|
||||
console.warn(caller)
|
||||
|
||||
return func.apply(null, arguments)
|
||||
}
|
||||
}
|
||||
+29
@@ -0,0 +1,29 @@
|
||||
module.exports = apiPlugin
|
||||
|
||||
const _ = require('lodash')
|
||||
|
||||
const method = require('./method')
|
||||
const deprecate = require('./deprecate')
|
||||
|
||||
const ENDPOINT_DEFAULTS = require('../../routes.json')
|
||||
|
||||
function apiPlugin (octokit) {
|
||||
Object.keys(ENDPOINT_DEFAULTS).forEach(namespaceName => {
|
||||
octokit[namespaceName] = {}
|
||||
|
||||
Object.keys(ENDPOINT_DEFAULTS[namespaceName]).forEach(apiName => {
|
||||
const apiOptions = ENDPOINT_DEFAULTS[namespaceName][apiName]
|
||||
const endpointDefaults = _.pick(apiOptions, ['method', 'url', 'headers', 'request'])
|
||||
|
||||
octokit[namespaceName][apiName] = method.bind(null, octokit, endpointDefaults, apiOptions.params)
|
||||
|
||||
// log deprecation warning for APIs flagged as deprecated
|
||||
if (apiOptions.deprecated) {
|
||||
octokit[namespaceName][apiName] = deprecate(
|
||||
octokit[namespaceName][apiName],
|
||||
apiOptions.deprecated
|
||||
)
|
||||
}
|
||||
})
|
||||
})
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
module.exports = apiMethod
|
||||
|
||||
const defaultsDeep = require('lodash/defaultsDeep')
|
||||
|
||||
const validate = require('./validate')
|
||||
|
||||
function apiMethod (octokit, endpointDefaults, endpointParams, options, callback) {
|
||||
const endpointOptions = defaultsDeep(options, endpointDefaults)
|
||||
|
||||
const promise = Promise.resolve(endpointOptions)
|
||||
.then(validate.bind(null, endpointParams))
|
||||
.then(octokit.request)
|
||||
|
||||
if (callback) {
|
||||
promise.then(callback.bind(null, null), callback)
|
||||
return
|
||||
}
|
||||
|
||||
return promise
|
||||
}
|
||||
+62
@@ -0,0 +1,62 @@
|
||||
'use strict'
|
||||
|
||||
module.exports = validate
|
||||
|
||||
const set = require('lodash/set')
|
||||
const HttpError = require('../../request/http-error')
|
||||
|
||||
function validate (endpointParams, options) {
|
||||
Object.keys(endpointParams).forEach(parameterName => {
|
||||
const parameter = endpointParams[parameterName]
|
||||
const expectedType = parameter.type
|
||||
let value = options[parameterName]
|
||||
|
||||
const paramIsPresent = parameterName in options
|
||||
const paramIsNull = value === null
|
||||
|
||||
if (!parameter.required && !paramIsPresent) {
|
||||
return
|
||||
}
|
||||
|
||||
if (parameter['allow-null'] === true && paramIsNull) {
|
||||
return
|
||||
}
|
||||
|
||||
if ((parameter.required && !paramIsPresent) ||
|
||||
(parameter['allow-null'] === false && paramIsNull)) {
|
||||
throw new HttpError(`Empty value for parameter '${parameterName}': ${value}`, 400)
|
||||
}
|
||||
|
||||
if (parameter.enum) {
|
||||
if (parameter.enum.indexOf(value) === -1) {
|
||||
throw new HttpError(`Invalid value for parameter '${parameterName}': ${value}`, 400)
|
||||
}
|
||||
}
|
||||
|
||||
if (parameter.validation) {
|
||||
const regex = new RegExp(parameter.validation)
|
||||
if (!regex.test(value)) {
|
||||
throw new HttpError(`Invalid value for parameter '${parameterName}': ${value}`, 400)
|
||||
}
|
||||
}
|
||||
|
||||
if (expectedType === 'number') {
|
||||
value = parseInt(value, 10)
|
||||
if (isNaN(value)) {
|
||||
throw new HttpError(`Invalid value for parameter '${parameterName}': ${options[parameterName]} is NaN`, 400)
|
||||
}
|
||||
}
|
||||
|
||||
if (expectedType === 'json' && typeof value === 'string') {
|
||||
try {
|
||||
value = JSON.parse(value)
|
||||
} catch (exception) {
|
||||
throw new HttpError(`JSON parse error of value for parameter '${parameterName}': ${value}`, 400)
|
||||
}
|
||||
}
|
||||
|
||||
set(options, parameter.mapTo || parameterName, value)
|
||||
})
|
||||
|
||||
return options
|
||||
}
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
module.exports = getFirstPage
|
||||
|
||||
const getPage = require('./get-page')
|
||||
|
||||
function getFirstPage (octokit, link, headers, callback) {
|
||||
return getPage(octokit, link, 'first', headers, callback)
|
||||
}
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
module.exports = getLastPage
|
||||
|
||||
const getPage = require('./get-page')
|
||||
|
||||
function getLastPage (octokit, link, headers, callback) {
|
||||
return getPage(octokit, link, 'last', headers, callback)
|
||||
}
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
module.exports = getNextPage
|
||||
|
||||
const getPage = require('./get-page')
|
||||
|
||||
function getNextPage (octokit, link, headers, callback) {
|
||||
return getPage(octokit, link, 'next', headers, callback)
|
||||
}
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
module.exports = getPageLinks
|
||||
|
||||
function getPageLinks (link) {
|
||||
link = link.link || link.meta.link || ''
|
||||
|
||||
const links = {}
|
||||
|
||||
// link format:
|
||||
// '<https://api.github.com/users/aseemk/followers?page=2>; rel="next", <https://api.github.com/users/aseemk/followers?page=2>; rel="last"'
|
||||
link.replace(/<([^>]*)>;\s*rel="([\w]*)"/g, (m, uri, type) => {
|
||||
links[type] = uri
|
||||
})
|
||||
|
||||
return links
|
||||
}
|
||||
+46
@@ -0,0 +1,46 @@
|
||||
module.exports = getPage
|
||||
|
||||
const HttpError = require('../../request/http-error')
|
||||
const getPageLinks = require('./get-page-links')
|
||||
|
||||
function getPage (octokit, link, which, headers, callback) {
|
||||
if (typeof headers === 'function') {
|
||||
callback = headers
|
||||
headers = null
|
||||
}
|
||||
|
||||
const url = getPageLinks(link)[which]
|
||||
|
||||
if (!url) {
|
||||
const urlError = new HttpError(`No ${which} page found`, 404)
|
||||
if (callback) {
|
||||
return callback(urlError)
|
||||
}
|
||||
return Promise.reject(urlError)
|
||||
}
|
||||
|
||||
const requestOptions = {
|
||||
url,
|
||||
headers: applyAcceptHeader(link, headers)
|
||||
}
|
||||
|
||||
const promise = octokit.request(requestOptions)
|
||||
|
||||
if (callback) {
|
||||
promise.then(callback.bind(null, null), callback)
|
||||
return
|
||||
}
|
||||
|
||||
return promise
|
||||
}
|
||||
|
||||
function applyAcceptHeader (res, headers) {
|
||||
const previous = res.meta && res.meta['x-github-media-type']
|
||||
|
||||
if (!previous || (headers && headers.accept)) {
|
||||
return headers
|
||||
}
|
||||
headers = headers || {}
|
||||
headers.accept = `application/vnd.${previous.replace('; format=', '+')}`
|
||||
return headers
|
||||
}
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
module.exports = getPreviousPage
|
||||
|
||||
const getPage = require('./get-page')
|
||||
|
||||
function getPreviousPage (octokit, link, headers, callback) {
|
||||
return getPage(octokit, link, 'prev', headers, callback)
|
||||
}
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
module.exports = hasFirstPage
|
||||
|
||||
const getPageLinks = require('./get-page-links')
|
||||
|
||||
function hasFirstPage (link) {
|
||||
return getPageLinks(link).first
|
||||
}
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
module.exports = hasLastPage
|
||||
|
||||
const getPageLinks = require('./get-page-links')
|
||||
|
||||
function hasLastPage (link) {
|
||||
return getPageLinks(link).last
|
||||
}
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
module.exports = hasNextPage
|
||||
|
||||
const getPageLinks = require('./get-page-links')
|
||||
|
||||
function hasNextPage (link) {
|
||||
return getPageLinks(link).next
|
||||
}
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
module.exports = hasPreviousPage
|
||||
|
||||
const getPageLinks = require('./get-page-links')
|
||||
|
||||
function hasPreviousPage (link) {
|
||||
return getPageLinks(link).prev
|
||||
}
|
||||
+12
@@ -0,0 +1,12 @@
|
||||
module.exports = paginationPlugin
|
||||
|
||||
function paginationPlugin (octokit) {
|
||||
octokit.getFirstPage = require('./get-first-page').bind(null, octokit)
|
||||
octokit.getLastPage = require('./get-last-page').bind(null, octokit)
|
||||
octokit.getNextPage = require('./get-next-page').bind(null, octokit)
|
||||
octokit.getPreviousPage = require('./get-previous-page').bind(null, octokit)
|
||||
octokit.hasFirstPage = require('./has-first-page')
|
||||
octokit.hasLastPage = require('./has-last-page')
|
||||
octokit.hasNextPage = require('./has-next-page')
|
||||
octokit.hasPreviousPage = require('./has-previous-page')
|
||||
}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
[back to `@octokit/rest`]('../..')
|
||||
|
||||
# `@octokit/rest/request`
|
||||
|
||||
> Turn REST API endpoint options into generic request options
|
||||
|
||||
---
|
||||
|
||||
# ⚠️ This is not a public API at this point and can change at any time
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const octokitRestRequest = require('@octokit/rest/lib/request')
|
||||
|
||||
octokitRestRequest({
|
||||
// request options
|
||||
method: 'GET',
|
||||
url: '/orgs/:org/repos',
|
||||
// parameters
|
||||
org: 'octokit',
|
||||
type: 'private'
|
||||
}) // returns promise
|
||||
```
|
||||
|
||||
Sends a `GET` request to https://api.github.com/orgs/octokit/repos?type=private&per_page=20&page=2
|
||||
with `user-agent` and `accept` headers set.
|
||||
|
||||
It accepts the same options and has the same defaults as [`@octokit/rest/endpoint`](../endpoint)
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
'use strict'
|
||||
|
||||
const STATUS_CODES = {
|
||||
304: 'Not Modified', // See PR #673 (https://github.com/octokit/rest.js/pull/673)
|
||||
400: 'Bad Request',
|
||||
404: 'Not Found',
|
||||
500: 'Internal Server Error',
|
||||
504: 'Gateway Timeout'
|
||||
}
|
||||
|
||||
module.exports = class HttpError extends Error {
|
||||
constructor (message, code, headers) {
|
||||
super(message)
|
||||
Error.captureStackTrace(this, this.constructor)
|
||||
this.name = 'HttpError'
|
||||
this.code = code
|
||||
this.status = STATUS_CODES[code]
|
||||
this.headers = headers
|
||||
}
|
||||
|
||||
toString () {
|
||||
return this.message
|
||||
}
|
||||
|
||||
toJSON () {
|
||||
return {
|
||||
code: this.code,
|
||||
status: this.status,
|
||||
message: this.message
|
||||
}
|
||||
}
|
||||
}
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
module.exports = restRequest
|
||||
|
||||
const restEndpoint = require('../endpoint')
|
||||
const request = require('./request')
|
||||
|
||||
function restRequest (endpointOptions) {
|
||||
const requestOptions = restEndpoint(endpointOptions)
|
||||
return request(requestOptions)
|
||||
}
|
||||
+116
@@ -0,0 +1,116 @@
|
||||
'use strict'
|
||||
|
||||
module.exports = httpRequest
|
||||
|
||||
const url = require('url')
|
||||
const http = require('http')
|
||||
const https = require('https')
|
||||
|
||||
const _ = require('lodash')
|
||||
const debug = require('debug')('octokit:rest')
|
||||
const isArrayBuffer = require('is-array-buffer')
|
||||
const isStream = require('is-stream')
|
||||
|
||||
const HttpError = require('./http-error')
|
||||
|
||||
function httpRequest (requestOptions) {
|
||||
requestOptions = Object.assign(
|
||||
url.parse(requestOptions.url),
|
||||
_.pick(requestOptions, 'method', 'body', 'headers', 'ca', 'family', 'proxy', 'rejectUnauthorized', 'timeout')
|
||||
)
|
||||
debug('REQUEST:', requestOptions)
|
||||
|
||||
// calculate content length unless body is a stream, in which case the
|
||||
// content length is already set per option
|
||||
if (requestOptions.body && !isStream(requestOptions.body)) {
|
||||
// stringify body unless it’s an ArrayBuffer
|
||||
if (!isArrayBuffer(requestOptions.body) && !Buffer.isBuffer(requestOptions.body) && typeof requestOptions.body !== 'string') {
|
||||
requestOptions.body = JSON.stringify(requestOptions.body)
|
||||
}
|
||||
|
||||
_.defaults(requestOptions.headers, {
|
||||
'content-type': 'application/json; charset=utf-8',
|
||||
'content-length': Buffer.byteLength(requestOptions.body, 'utf8')
|
||||
})
|
||||
}
|
||||
|
||||
// GitHub expects "content-length: 0" header for PUT/PATCH requests without body
|
||||
if (['patch', 'put'].indexOf(requestOptions.method) >= 0 &&
|
||||
!requestOptions.headers['content-length']) {
|
||||
requestOptions.headers['content-length'] = 0
|
||||
}
|
||||
|
||||
if ('content-length' in requestOptions.headers) {
|
||||
requestOptions.headers['content-length'] = parseInt(requestOptions.headers['content-length'], 10)
|
||||
}
|
||||
|
||||
const reqModule = requestOptions.protocol === 'http:' ? http : https
|
||||
delete requestOptions.protocol
|
||||
|
||||
return new Promise((resolve, reject) => {
|
||||
const request = reqModule.request(requestOptions, (response) => {
|
||||
debug('STATUS: ' + response.statusCode)
|
||||
debug('HEADERS: ' + JSON.stringify(response.headers))
|
||||
|
||||
response.setEncoding('utf8')
|
||||
let data = ''
|
||||
response.on('data', (chunk) => {
|
||||
data += chunk
|
||||
})
|
||||
|
||||
/* istanbul ignore next */
|
||||
response.on('error', (error) => {
|
||||
reject(new HttpError(error.message, 500))
|
||||
})
|
||||
response.on('end', () => {
|
||||
if (response.statusCode !== 304 && response.statusCode >= 301 && response.statusCode <= 307) {
|
||||
requestOptions.url = response.headers.location
|
||||
httpRequest(requestOptions).then(resolve, reject)
|
||||
return
|
||||
}
|
||||
|
||||
if (response.statusCode === 304 || response.statusCode >= 400 || response.statusCode < 10) {
|
||||
reject(new HttpError(data, response.statusCode, response.headers))
|
||||
return
|
||||
}
|
||||
|
||||
const contentType = response.headers['content-type']
|
||||
if (contentType && contentType.indexOf('application/json') !== -1) {
|
||||
data = data && JSON.parse(data)
|
||||
}
|
||||
|
||||
resolve({
|
||||
meta: response.headers,
|
||||
data
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
let aborted
|
||||
request.on('error', (error) => {
|
||||
if (aborted) return
|
||||
debug('REQUEST ERROR: ' + error.message)
|
||||
reject(new HttpError(error.message, 500))
|
||||
})
|
||||
|
||||
if (requestOptions.timeout) {
|
||||
request.setTimeout(requestOptions.timeout)
|
||||
}
|
||||
request.on('timeout', () => {
|
||||
debug('REQUEST ERROR: timed out')
|
||||
request.abort()
|
||||
aborted = true
|
||||
reject(new HttpError('Request timeout', 504))
|
||||
})
|
||||
|
||||
if (requestOptions.body) {
|
||||
if (isStream(requestOptions.body)) {
|
||||
return requestOptions.body.pipe(request)
|
||||
}
|
||||
|
||||
request.write(Buffer.from(requestOptions.body))
|
||||
}
|
||||
|
||||
request.end()
|
||||
})
|
||||
}
|
||||
+10630
File diff suppressed because it is too large.
Load diff
+140
@@ -0,0 +1,140 @@
|
||||
{
|
||||
"_from": "@octokit/rest",
|
||||
"_id": "@octokit/rest@14.0.9",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha512-irP9phKfTXEZIcW2R+VNCtGHZJrXMWmSYp6RRfFn4BtAqtDRXF5z9JxCEQlAhNBf6X1koNi5k49tIAAAEJNlVQ==",
|
||||
"_location": "/@octokit/rest",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"type": "tag",
|
||||
"registry": true,
|
||||
"raw": "@octokit/rest",
|
||||
"name": "@octokit/rest",
|
||||
"escapedName": "@octokit%2frest",
|
||||
"scope": "@octokit",
|
||||
"rawSpec": "",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "latest"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"#USER",
|
||||
"/"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-14.0.9.tgz",
|
||||
"_shasum": "d5e0a00dcb78901dd7b2ef852acfc0aea7c479ef",
|
||||
"_spec": "@octokit/rest",
|
||||
"_where": "C:\\Users\\Luis\\source\\repos\\AAWebPlatform",
|
||||
"apidoc": {
|
||||
"template": {
|
||||
"withCompare": false
|
||||
}
|
||||
},
|
||||
"author": {
|
||||
"name": "Gregor Martynus",
|
||||
"url": "https://github.com/gr2m"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/octokit/rest.js/issues"
|
||||
},
|
||||
"bundleDependencies": false,
|
||||
"contributors": [
|
||||
{
|
||||
"name": "Mike de Boer",
|
||||
"email": "info@mikedeboer.nl"
|
||||
},
|
||||
{
|
||||
"name": "Fabian Jakobs",
|
||||
"email": "fabian@c9.io"
|
||||
},
|
||||
{
|
||||
"name": "Joe Gallo",
|
||||
"email": "joe@brassafrax.com"
|
||||
},
|
||||
{
|
||||
"name": "Gregor Martynus",
|
||||
"url": "https://github.com/gr2m"
|
||||
}
|
||||
],
|
||||
"dependencies": {
|
||||
"before-after-hook": "^1.1.0",
|
||||
"debug": "^3.1.0",
|
||||
"is-array-buffer": "^1.0.0",
|
||||
"is-stream": "^1.1.0",
|
||||
"lodash": "^4.17.4",
|
||||
"url-template": "^2.0.8"
|
||||
},
|
||||
"deprecated": false,
|
||||
"description": "GitHub REST API client for Node.js",
|
||||
"devDependencies": {
|
||||
"@octokit/fixtures": "^6.0.0",
|
||||
"apidoc": "^0.17.6",
|
||||
"chai": "^4.1.2",
|
||||
"coveralls": "^3.0.0",
|
||||
"dotenv": "^5.0.0",
|
||||
"gh-pages-with-token": "^1.0.0",
|
||||
"glob": "^7.1.2",
|
||||
"mkdirp": "^0.5.1",
|
||||
"mocha": "^5.0.0",
|
||||
"mustache": "^2.2.1",
|
||||
"nock": "^9.1.0",
|
||||
"npm-run-all": "^4.1.1",
|
||||
"nyc": "^11.2.1",
|
||||
"proxyquire": "^1.8.0",
|
||||
"semantic-release": "^12.2.2",
|
||||
"simple-mock": "^0.8.0",
|
||||
"standard": "^10.0.3",
|
||||
"standard-markdown": "^4.0.2",
|
||||
"string-to-arraybuffer": "^1.0.0",
|
||||
"typescript": "^2.6.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=4"
|
||||
},
|
||||
"files": [
|
||||
"index.js",
|
||||
"index.d.ts",
|
||||
"index.js.flow",
|
||||
"lib"
|
||||
],
|
||||
"homepage": "https://github.com/octokit/rest.js#readme",
|
||||
"keywords": [
|
||||
"octokit",
|
||||
"github",
|
||||
"rest",
|
||||
"api-client"
|
||||
],
|
||||
"license": "MIT",
|
||||
"name": "@octokit/rest",
|
||||
"nyc": {
|
||||
"ignore": [
|
||||
"examples",
|
||||
"test"
|
||||
]
|
||||
},
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/octokit/rest.js.git"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "npm-run-all build:*",
|
||||
"build:docs": "node scripts/generate-api-docs",
|
||||
"build:flow": "node scripts/generate-flow-types",
|
||||
"build:ts": "node scripts/generate-typescript-types",
|
||||
"coverage": "nyc report --reporter=html && open coverage/index.html",
|
||||
"coverage:upload": "nyc report --reporter=text-lcov | coveralls",
|
||||
"deploy-docs": "gh-pages-with-token -d doc",
|
||||
"postbuild:docs": "apidoc -i doc/ -o doc/",
|
||||
"prebuild:docs": "mkdirp doc/",
|
||||
"pretest": "standard && standard-markdown",
|
||||
"prevalidate:ts": "npm run -s build:ts",
|
||||
"semantic-release": "semantic-release",
|
||||
"test": "nyc mocha 'test/**/*-test.js'",
|
||||
"test:examples": "node test/examples.js",
|
||||
"validate:ts": "tsc --target es6 index.d.ts"
|
||||
},
|
||||
"types": "index.d.ts",
|
||||
"version": "14.0.9"
|
||||
}
|
||||
+201
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 2016 Gregor Martynus and other contributors.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
+442
@@ -0,0 +1,442 @@
|
||||
# before-after-hook
|
||||
|
||||
> asynchronous before/error/after hooks for internal functionality
|
||||
|
||||
[](https://travis-ci.org/gr2m/before-after-hook)
|
||||
[](https://coveralls.io/r/gr2m/before-after-hook?branch=master)
|
||||
[](https://greenkeeper.io/)
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
// instantiate hook API
|
||||
const hook = new Hook()
|
||||
|
||||
// Create a hook
|
||||
hook('get', getData)
|
||||
.then(handleData)
|
||||
.catch(handleGetError)
|
||||
|
||||
// register before/after/error hooks.
|
||||
// The methods can be asynchronous by returning a Promise
|
||||
hook.before('get', beforeHook)
|
||||
hook.error('get', errorHook)
|
||||
hook.after('get', afterHook)
|
||||
```
|
||||
|
||||
The methods are executed in the following order
|
||||
|
||||
1. `beforeHook`
|
||||
2. `getData`
|
||||
3. `afterHook`
|
||||
4. `handleData`
|
||||
|
||||
If an error is thrown in `beforeHook` or `getData` then `errorHook` is
|
||||
called next.
|
||||
|
||||
If `afterHook` throws an error then `handleGetError` is called instead
|
||||
of `handleData`.
|
||||
|
||||
If `errorHook` throws an error then `handleGetError` is called next, otherwise
|
||||
`afterHook` and `handleData`.
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
npm install before-after-hook
|
||||
```
|
||||
|
||||
Or download [the latest `before-after-hook.min.js`](https://github.com/gr2m/before-after-hook/releases/latest).
|
||||
|
||||
## API
|
||||
|
||||
- [Constructor](#constructor)
|
||||
- [hook.api](#hookapi)
|
||||
- [hook()](#hook)
|
||||
- [hook.before()](#hookbefore)
|
||||
- [hook.error()](#hookerror)
|
||||
- [hook.after()](#hookafter)
|
||||
- [hook.remove.before()](#hookremovebefore)
|
||||
- [hook.remove.error()](#hookremoveerror)
|
||||
- [hook.remove.after()](#hookremoveafter)
|
||||
|
||||
### Constructor
|
||||
|
||||
The `Hook` constructor has no options and returns a `hook` instance with the
|
||||
methods below
|
||||
|
||||
```js
|
||||
const hook = new Hook()
|
||||
```
|
||||
|
||||
### hook.api
|
||||
|
||||
Use the `api` property to return the public API:
|
||||
|
||||
- [hook.before()](#hookbefore)
|
||||
- [hook.after()](#hookafter)
|
||||
- [hook.error()](#hookafter)
|
||||
- [hook.remove.before()](#hookremovebefore)
|
||||
- [hook.remove.after()](#hookremoveafter)
|
||||
- [hook.remove.error()](#hookremoveerror)
|
||||
|
||||
That way you don’t need to expose the [hook()](#hook) method to consumers of your library
|
||||
|
||||
### hook()
|
||||
|
||||
Invoke before and after hooks. Returns a promise.
|
||||
|
||||
```js
|
||||
hook(nameOrNames, [options,] method)
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Argument</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<th align="left"><code>name</code></th>
|
||||
<td>String or Array of Strings</td>
|
||||
<td>Hook name, for example <code>'save'</code>. Or an array of names, see example below.</td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th align="left"><code>options</code></th>
|
||||
<td>Object</td>
|
||||
<td>Will be passed to all before hooks as reference, so they can mutate it</td>
|
||||
<td>No, defaults to empty object (<code>{}</code>)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th align="left"><code>method</code></th>
|
||||
<td>Function</td>
|
||||
<td>Callback to be executed after all before hooks finished execution successfully. <code>options</code> is passed as first argument</td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Resolves with whatever `method` returns or resolves with.
|
||||
Rejects with error that is thrown or rejected with by
|
||||
|
||||
1. Any of the before hooks, whichever rejects / throws first
|
||||
2. `method`
|
||||
3. Any of the after hooks, whichever rejects / throws first
|
||||
|
||||
Simple Example
|
||||
|
||||
```js
|
||||
hook('save', record, function (record) {
|
||||
return store.save(record)
|
||||
})
|
||||
// shorter: hook('save', record, store.save)
|
||||
|
||||
hook.before('save', function addTimestamps (record) {
|
||||
const now = new Date().toISOString()
|
||||
if (record.createdAt) {
|
||||
record.updatedAt = now
|
||||
} else {
|
||||
record.createdAt = now
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
Example defining multiple hooks at once.
|
||||
|
||||
```js
|
||||
hook(['add', 'save'], record, function (record) {
|
||||
return store.save(record)
|
||||
})
|
||||
|
||||
hook.before('add', function addTimestamps (record) {
|
||||
if (!record.type) {
|
||||
throw new Error('type property is required')
|
||||
}
|
||||
})
|
||||
|
||||
hook.before('save', function addTimestamps (record) {
|
||||
if (!record.type) {
|
||||
throw new Error('type property is required')
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
Defining multiple hooks is helpful if you have similar methods for which you want to define separate hooks, but also an additional hook that gets called for all at once. The example above is equal to this:
|
||||
|
||||
```js
|
||||
hook('add', record, function (record) {
|
||||
return hook('save', record, function (record) {
|
||||
return store.save(record)
|
||||
})
|
||||
})
|
||||
```
|
||||
|
||||
### hook.before()
|
||||
|
||||
Add before hook for given name. Returns `hook` instance for chaining.
|
||||
|
||||
```js
|
||||
hook.before(name, method)
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Argument</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<th align="left"><code>name</code></th>
|
||||
<td>String</td>
|
||||
<td>Hook name, for example <code>'save'</code></td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th align="left"><code>method</code></th>
|
||||
<td>Function</td>
|
||||
<td>
|
||||
Executed before the wrapped method. Called with the hook’s
|
||||
<code>options</code> argument. Before hooks can mutate the passed options
|
||||
before they are passed to the wrapped method.
|
||||
</td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Example
|
||||
|
||||
```js
|
||||
hook.before('save', function validate (record) {
|
||||
if (!record.name) {
|
||||
throw new Error('name property is required')
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### hook.error()
|
||||
|
||||
Add error hook for given name. Returns `hook` instance for chaining.
|
||||
|
||||
```js
|
||||
hook.error(name, method)
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Argument</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<th align="left"><code>name</code></th>
|
||||
<td>String</td>
|
||||
<td>Hook name, for example <code>'save'</code></td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th align="left"><code>method</code></th>
|
||||
<td>Function</td>
|
||||
<td>
|
||||
Executed when an error occurred in either the wrapped method or a
|
||||
<code>before</code> hook. Called with the thrown <code>error</code>
|
||||
and the hook’s <code>options</code> argument. The first <code>method</code>
|
||||
which does not throw an error will set the result that the after hook
|
||||
methods will receive.
|
||||
</td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Example
|
||||
|
||||
```js
|
||||
hook.error('save', function (error, options) {
|
||||
if (error.ignore) return
|
||||
throw error
|
||||
})
|
||||
```
|
||||
|
||||
### hook.after()
|
||||
|
||||
Add after hook for given name. Returns `hook` instance for chaining.
|
||||
|
||||
```js
|
||||
hook.after(name, method)
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Argument</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<th align="left"><code>name</code></th>
|
||||
<td>String</td>
|
||||
<td>Hook name, for example <code>'save'</code></td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th align="left"><code>method</code></th>
|
||||
<td>Function</td>
|
||||
<td>
|
||||
Executed after wrapped method. Called with what the wrapped method
|
||||
resolves with the hook’s <code>options</code> argument.
|
||||
</td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Example
|
||||
|
||||
```js
|
||||
hook.after('save', function (result, options) {
|
||||
if (result.updatedAt) {
|
||||
app.emit('update', result)
|
||||
} else {
|
||||
app.emit('create', result)
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### hook.remove.before()
|
||||
|
||||
Removes before hook for given name. Returns `hook` instance for chaining.
|
||||
|
||||
```js
|
||||
hook.remove.before(name, beforeHookMethod)
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Argument</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<th align="left"><code>name</code></th>
|
||||
<td>String</td>
|
||||
<td>Hook name, for example <code>'save'</code></td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th align="left"><code>beforeHookMethod</code></th>
|
||||
<td>Function</td>
|
||||
<td>
|
||||
Same function that was previously passed to <code>hook.before()</code>
|
||||
</td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Example
|
||||
|
||||
```js
|
||||
hook.remove.before('save', validateRecord)
|
||||
```
|
||||
|
||||
### hook.remove.error()
|
||||
|
||||
Removes error hook for given name. Returns `hook` instance for chaining.
|
||||
|
||||
```js
|
||||
hook.remove.error(name, afterHookMethod)
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Argument</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<th align="left"><code>name</code></th>
|
||||
<td>String</td>
|
||||
<td>Hook name, for example <code>'save'</code></td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th align="left"><code>afterHookMethod</code></th>
|
||||
<td>Function</td>
|
||||
<td>
|
||||
Same function that was previously passed to <code>hook.error()</code>
|
||||
</td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Example
|
||||
|
||||
```js
|
||||
hook.remove.error('save', handleError)
|
||||
```
|
||||
|
||||
### hook.remove.after()
|
||||
|
||||
Removes after hook for given name. Returns `hook` instance for chaining.
|
||||
|
||||
```js
|
||||
hook.remove.after(name, afterHookMethod)
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Argument</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<th align="left"><code>name</code></th>
|
||||
<td>String</td>
|
||||
<td>Hook name, for example <code>'save'</code></td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th align="left"><code>afterHookMethod</code></th>
|
||||
<td>Function</td>
|
||||
<td>
|
||||
Same function that was previously passed to <code>hook.after()</code>
|
||||
</td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Example
|
||||
|
||||
```js
|
||||
hook.remove.after('save', triggerEvents)
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
If `before-after-hook` is not for you, have a look at one of these alternatives:
|
||||
|
||||
- https://github.com/keystonejs/grappling-hook
|
||||
- https://github.com/sebelga/promised-hooks
|
||||
- https://github.com/bnoguchi/hooks-js
|
||||
- https://github.com/cb1kenobi/hook-emitter
|
||||
|
||||
## License
|
||||
|
||||
[Apache 2.0](LICENSE)
|
||||
+22
@@ -0,0 +1,22 @@
|
||||
module.exports = Hook
|
||||
|
||||
var register = require('./lib/register')
|
||||
var addHook = require('./lib/add')
|
||||
var removeHook = require('./lib/remove')
|
||||
|
||||
function Hook () {
|
||||
var state = {
|
||||
registry: {}
|
||||
}
|
||||
|
||||
var hook = register.bind(null, state)
|
||||
hook.remove = {}
|
||||
hook.api = {remove: {}}
|
||||
|
||||
;['before', 'error', 'after'].forEach(function (kind) {
|
||||
hook[kind] = hook.api[kind] = addHook.bind(null, state, kind)
|
||||
hook.remove[kind] = hook.api.remove[kind] = removeHook.bind(null, state, kind)
|
||||
})
|
||||
|
||||
return hook
|
||||
}
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
module.exports = addHook
|
||||
|
||||
function addHook (state, kind, name, hook) {
|
||||
if (!state.registry[name]) {
|
||||
state.registry[name] = {
|
||||
before: [],
|
||||
error: [],
|
||||
after: []
|
||||
}
|
||||
}
|
||||
|
||||
state.registry[name][kind][kind === 'before' ? 'unshift' : 'push'](hook)
|
||||
}
|
||||
+104
@@ -0,0 +1,104 @@
|
||||
module.exports = register
|
||||
|
||||
function register (state, name, options, method) {
|
||||
if (arguments.length === 3) {
|
||||
method = options
|
||||
options = {}
|
||||
}
|
||||
|
||||
if (typeof method !== 'function') {
|
||||
throw new Error('method for before hook must be a function')
|
||||
}
|
||||
|
||||
if (typeof options !== 'object') {
|
||||
throw new Error('options for before hook must be an object')
|
||||
}
|
||||
|
||||
if (Array.isArray(name)) {
|
||||
return name.reverse().reduce(function (callback, name) {
|
||||
return register.bind(null, state, name, options, callback)
|
||||
}, method)()
|
||||
}
|
||||
|
||||
var hooks = state.registry[name]
|
||||
|
||||
if (!hooks) {
|
||||
return invokeMethod(options, method)
|
||||
}
|
||||
|
||||
var beforeHooks = hooks.before
|
||||
var errorHooks = hooks.error
|
||||
var afterHooks = hooks.after
|
||||
|
||||
// 1. run "before hooks" which may mutate options
|
||||
return Promise.all(beforeHooks.map(invokeBeforeHook.bind(null, options)))
|
||||
|
||||
// 2. Once all finish without error, call the method with the (mutated) options
|
||||
.then(function () {
|
||||
return method(options)
|
||||
})
|
||||
|
||||
// 3. If an error occurs in 1. or 2. run the "error hooks" which may mutate
|
||||
// the error object. If one of them does not return an error then set the
|
||||
// result to that. Otherwise throw (mutated) error.
|
||||
.catch(function (error) {
|
||||
return Promise.all(errorHooks.map(invokeErrorHook.bind(null, error, options)))
|
||||
|
||||
.then(function (results) {
|
||||
var nonErrorResults = results.filter(isntError)
|
||||
|
||||
if (nonErrorResults.length) {
|
||||
return nonErrorResults[0]
|
||||
}
|
||||
|
||||
throw error
|
||||
})
|
||||
})
|
||||
|
||||
// 4. Run the "after hooks". They may mutate the result
|
||||
.then(function (result) {
|
||||
return Promise.all(afterHooks.map(invokeAfterHook.bind(null, result, options)))
|
||||
|
||||
.then(function () {
|
||||
return result
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
function invokeMethod (options, method) {
|
||||
try {
|
||||
return Promise.resolve(method(options))
|
||||
} catch (error) {
|
||||
return Promise.reject(error)
|
||||
}
|
||||
}
|
||||
|
||||
function invokeBeforeHook (options, method) {
|
||||
try {
|
||||
return method(options)
|
||||
} catch (error) {
|
||||
return Promise.reject(error)
|
||||
}
|
||||
}
|
||||
|
||||
function invokeErrorHook (result, options, errorHook) {
|
||||
try {
|
||||
return Promise.resolve(errorHook(result, options))
|
||||
|
||||
.catch(function (error) { return error })
|
||||
} catch (error) {
|
||||
return Promise.resolve(error)
|
||||
}
|
||||
}
|
||||
|
||||
function invokeAfterHook (result, options, method) {
|
||||
try {
|
||||
return method(result, options)
|
||||
} catch (error) {
|
||||
return Promise.reject(error)
|
||||
}
|
||||
}
|
||||
|
||||
function isntError (result) {
|
||||
return !(result instanceof Error)
|
||||
}
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
module.exports = removeHook
|
||||
|
||||
function removeHook (state, kind, name, method) {
|
||||
if (!state.registry[name]) {
|
||||
return
|
||||
}
|
||||
|
||||
var index = state.registry[name][kind].indexOf(method)
|
||||
|
||||
if (index === -1) {
|
||||
return
|
||||
}
|
||||
|
||||
state.registry[name][kind].splice(index, 1)
|
||||
}
|
||||
+91
@@ -0,0 +1,91 @@
|
||||
{
|
||||
"_from": "before-after-hook@^1.1.0",
|
||||
"_id": "before-after-hook@1.1.0",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha512-VOMDtYPwLbIncTxNoSzRyvaMxtXmLWLUqr8k5AfC1BzLk34HvBXaQX8snOwQZ4c0aX8aSERqtJSiI9/m2u5kuA==",
|
||||
"_location": "/before-after-hook",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"type": "range",
|
||||
"registry": true,
|
||||
"raw": "before-after-hook@^1.1.0",
|
||||
"name": "before-after-hook",
|
||||
"escapedName": "before-after-hook",
|
||||
"rawSpec": "^1.1.0",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "^1.1.0"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/@octokit/rest"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-1.1.0.tgz",
|
||||
"_shasum": "83165e15a59460d13702cb8febd6a1807896db5a",
|
||||
"_spec": "before-after-hook@^1.1.0",
|
||||
"_where": "C:\\Users\\Luis\\source\\repos\\AAWebPlatform\\node_modules\\@octokit\\rest",
|
||||
"author": {
|
||||
"name": "Gregor Martynus"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/gr2m/before-after-hook/issues"
|
||||
},
|
||||
"bundleDependencies": false,
|
||||
"dependencies": {},
|
||||
"deprecated": false,
|
||||
"description": "asynchronous before/error/after hooks for internal functionality",
|
||||
"devDependencies": {
|
||||
"browserify": "^15.0.0",
|
||||
"gaze-cli": "^0.2.0",
|
||||
"istanbul": "^0.4.0",
|
||||
"istanbul-coveralls": "^1.0.3",
|
||||
"mkdirp": "^0.5.1",
|
||||
"rimraf": "^2.4.4",
|
||||
"semantic-release": "^12.2.2",
|
||||
"simple-mock": "^0.8.0",
|
||||
"standard": "^10.0.0",
|
||||
"tap-min": "^1.0.0",
|
||||
"tap-spec": "^4.1.1",
|
||||
"tape": "^4.2.2",
|
||||
"uglify-js": "^3.0.0"
|
||||
},
|
||||
"files": [
|
||||
"index.js",
|
||||
"lib"
|
||||
],
|
||||
"homepage": "https://github.com/gr2m/before-after-hook#readme",
|
||||
"keywords": [
|
||||
"hook",
|
||||
"hooks",
|
||||
"api"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"name": "before-after-hook",
|
||||
"release": {
|
||||
"publish": [
|
||||
"@semantic-release/npm",
|
||||
{
|
||||
"path": "@semantic-release/github",
|
||||
"assets": [
|
||||
"dist/*.js"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/gr2m/before-after-hook.git"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "browserify index.js --standalone=Hook > dist/before-after-hook.js",
|
||||
"postbuild": "uglifyjs dist/before-after-hook.js -mc > dist/before-after-hook.min.js",
|
||||
"prebuild": "rimraf dist && mkdirp dist",
|
||||
"presemantic-release": "npm run build",
|
||||
"pretest": "standard",
|
||||
"semantic-release": "semantic-release",
|
||||
"test": "npm run -s test:node | tap-spec",
|
||||
"test:coverage": "istanbul cover test",
|
||||
"test:coverage:upload": "istanbul-coveralls",
|
||||
"test:node": "node test",
|
||||
"test:watch": "gaze 'clear && node test | tap-min' 'test/**/*.js' 'index.js' 'lib/**/*.js'"
|
||||
},
|
||||
"version": "1.1.0"
|
||||
}
|
||||
+1
@@ -0,0 +1 @@
|
||||
repo_token: SIAeZjKYlHK74rbcFvNHMUzjRiMpflxve
|
||||
+14
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"env": {
|
||||
"browser": true,
|
||||
"node": true
|
||||
},
|
||||
"globals": {
|
||||
"chrome": true
|
||||
},
|
||||
"rules": {
|
||||
"no-console": 0,
|
||||
"no-empty": [1, { "allowEmptyCatch": true }]
|
||||
},
|
||||
"extends": "eslint:recommended"
|
||||
}
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
support
|
||||
test
|
||||
examples
|
||||
example
|
||||
*.sock
|
||||
dist
|
||||
yarn.lock
|
||||
coverage
|
||||
bower.json
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
sudo: false
|
||||
|
||||
language: node_js
|
||||
|
||||
node_js:
|
||||
- "4"
|
||||
- "6"
|
||||
- "8"
|
||||
|
||||
install:
|
||||
- make install
|
||||
|
||||
script:
|
||||
- make lint
|
||||
- make test
|
||||
|
||||
matrix:
|
||||
include:
|
||||
- node_js: '8'
|
||||
env: BROWSER=1
|
||||
+395
@@ -0,0 +1,395 @@
|
||||
|
||||
3.1.0 / 2017-09-26
|
||||
==================
|
||||
|
||||
* Add `DEBUG_HIDE_DATE` env var (#486)
|
||||
* Remove ReDoS regexp in %o formatter (#504)
|
||||
* Remove "component" from package.json
|
||||
* Remove `component.json`
|
||||
* Ignore package-lock.json
|
||||
* Examples: fix colors printout
|
||||
* Fix: browser detection
|
||||
* Fix: spelling mistake (#496, @EdwardBetts)
|
||||
|
||||
3.0.1 / 2017-08-24
|
||||
==================
|
||||
|
||||
* Fix: Disable colors in Edge and Internet Explorer (#489)
|
||||
|
||||
3.0.0 / 2017-08-08
|
||||
==================
|
||||
|
||||
* Breaking: Remove DEBUG_FD (#406)
|
||||
* Breaking: Use `Date#toISOString()` instead to `Date#toUTCString()` when output is not a TTY (#418)
|
||||
* Breaking: Make millisecond timer namespace specific and allow 'always enabled' output (#408)
|
||||
* Addition: document `enabled` flag (#465)
|
||||
* Addition: add 256 colors mode (#481)
|
||||
* Addition: `enabled()` updates existing debug instances, add `destroy()` function (#440)
|
||||
* Update: component: update "ms" to v2.0.0
|
||||
* Update: separate the Node and Browser tests in Travis-CI
|
||||
* Update: refactor Readme, fixed documentation, added "Namespace Colors" section, redid screenshots
|
||||
* Update: separate Node.js and web browser examples for organization
|
||||
* Update: update "browserify" to v14.4.0
|
||||
* Fix: fix Readme typo (#473)
|
||||
|
||||
2.6.9 / 2017-09-22
|
||||
==================
|
||||
|
||||
* remove ReDoS regexp in %o formatter (#504)
|
||||
|
||||
2.6.8 / 2017-05-18
|
||||
==================
|
||||
|
||||
* Fix: Check for undefined on browser globals (#462, @marbemac)
|
||||
|
||||
2.6.7 / 2017-05-16
|
||||
==================
|
||||
|
||||
* Fix: Update ms to 2.0.0 to fix regular expression denial of service vulnerability (#458, @hubdotcom)
|
||||
* Fix: Inline extend function in node implementation (#452, @dougwilson)
|
||||
* Docs: Fix typo (#455, @msasad)
|
||||
|
||||
2.6.5 / 2017-04-27
|
||||
==================
|
||||
|
||||
* Fix: null reference check on window.documentElement.style.WebkitAppearance (#447, @thebigredgeek)
|
||||
* Misc: clean up browser reference checks (#447, @thebigredgeek)
|
||||
* Misc: add npm-debug.log to .gitignore (@thebigredgeek)
|
||||
|
||||
|
||||
2.6.4 / 2017-04-20
|
||||
==================
|
||||
|
||||
* Fix: bug that would occur if process.env.DEBUG is a non-string value. (#444, @LucianBuzzo)
|
||||
* Chore: ignore bower.json in npm installations. (#437, @joaovieira)
|
||||
* Misc: update "ms" to v0.7.3 (@tootallnate)
|
||||
|
||||
2.6.3 / 2017-03-13
|
||||
==================
|
||||
|
||||
* Fix: Electron reference to `process.env.DEBUG` (#431, @paulcbetts)
|
||||
* Docs: Changelog fix (@thebigredgeek)
|
||||
|
||||
2.6.2 / 2017-03-10
|
||||
==================
|
||||
|
||||
* Fix: DEBUG_MAX_ARRAY_LENGTH (#420, @slavaGanzin)
|
||||
* Docs: Add backers and sponsors from Open Collective (#422, @piamancini)
|
||||
* Docs: Add Slackin invite badge (@tootallnate)
|
||||
|
||||
2.6.1 / 2017-02-10
|
||||
==================
|
||||
|
||||
* Fix: Module's `export default` syntax fix for IE8 `Expected identifier` error
|
||||
* Fix: Whitelist DEBUG_FD for values 1 and 2 only (#415, @pi0)
|
||||
* Fix: IE8 "Expected identifier" error (#414, @vgoma)
|
||||
* Fix: Namespaces would not disable once enabled (#409, @musikov)
|
||||
|
||||
2.6.0 / 2016-12-28
|
||||
==================
|
||||
|
||||
* Fix: added better null pointer checks for browser useColors (@thebigredgeek)
|
||||
* Improvement: removed explicit `window.debug` export (#404, @tootallnate)
|
||||
* Improvement: deprecated `DEBUG_FD` environment variable (#405, @tootallnate)
|
||||
|
||||
2.5.2 / 2016-12-25
|
||||
==================
|
||||
|
||||
* Fix: reference error on window within webworkers (#393, @KlausTrainer)
|
||||
* Docs: fixed README typo (#391, @lurch)
|
||||
* Docs: added notice about v3 api discussion (@thebigredgeek)
|
||||
|
||||
2.5.1 / 2016-12-20
|
||||
==================
|
||||
|
||||
* Fix: babel-core compatibility
|
||||
|
||||
2.5.0 / 2016-12-20
|
||||
==================
|
||||
|
||||
* Fix: wrong reference in bower file (@thebigredgeek)
|
||||
* Fix: webworker compatibility (@thebigredgeek)
|
||||
* Fix: output formatting issue (#388, @kribblo)
|
||||
* Fix: babel-loader compatibility (#383, @escwald)
|
||||
* Misc: removed built asset from repo and publications (@thebigredgeek)
|
||||
* Misc: moved source files to /src (#378, @yamikuronue)
|
||||
* Test: added karma integration and replaced babel with browserify for browser tests (#378, @yamikuronue)
|
||||
* Test: coveralls integration (#378, @yamikuronue)
|
||||
* Docs: simplified language in the opening paragraph (#373, @yamikuronue)
|
||||
|
||||
2.4.5 / 2016-12-17
|
||||
==================
|
||||
|
||||
* Fix: `navigator` undefined in Rhino (#376, @jochenberger)
|
||||
* Fix: custom log function (#379, @hsiliev)
|
||||
* Improvement: bit of cleanup + linting fixes (@thebigredgeek)
|
||||
* Improvement: rm non-maintainted `dist/` dir (#375, @freewil)
|
||||
* Docs: simplified language in the opening paragraph. (#373, @yamikuronue)
|
||||
|
||||
2.4.4 / 2016-12-14
|
||||
==================
|
||||
|
||||
* Fix: work around debug being loaded in preload scripts for electron (#368, @paulcbetts)
|
||||
|
||||
2.4.3 / 2016-12-14
|
||||
==================
|
||||
|
||||
* Fix: navigation.userAgent error for react native (#364, @escwald)
|
||||
|
||||
2.4.2 / 2016-12-14
|
||||
==================
|
||||
|
||||
* Fix: browser colors (#367, @tootallnate)
|
||||
* Misc: travis ci integration (@thebigredgeek)
|
||||
* Misc: added linting and testing boilerplate with sanity check (@thebigredgeek)
|
||||
|
||||
2.4.1 / 2016-12-13
|
||||
==================
|
||||
|
||||
* Fix: typo that broke the package (#356)
|
||||
|
||||
2.4.0 / 2016-12-13
|
||||
==================
|
||||
|
||||
* Fix: bower.json references unbuilt src entry point (#342, @justmatt)
|
||||
* Fix: revert "handle regex special characters" (@tootallnate)
|
||||
* Feature: configurable util.inspect()`options for NodeJS (#327, @tootallnate)
|
||||
* Feature: %O`(big O) pretty-prints objects (#322, @tootallnate)
|
||||
* Improvement: allow colors in workers (#335, @botverse)
|
||||
* Improvement: use same color for same namespace. (#338, @lchenay)
|
||||
|
||||
2.3.3 / 2016-11-09
|
||||
==================
|
||||
|
||||
* Fix: Catch `JSON.stringify()` errors (#195, Jovan Alleyne)
|
||||
* Fix: Returning `localStorage` saved values (#331, Levi Thomason)
|
||||
* Improvement: Don't create an empty object when no `process` (Nathan Rajlich)
|
||||
|
||||
2.3.2 / 2016-11-09
|
||||
==================
|
||||
|
||||
* Fix: be super-safe in index.js as well (@TooTallNate)
|
||||
* Fix: should check whether process exists (Tom Newby)
|
||||
|
||||
2.3.1 / 2016-11-09
|
||||
==================
|
||||
|
||||
* Fix: Added electron compatibility (#324, @paulcbetts)
|
||||
* Improvement: Added performance optimizations (@tootallnate)
|
||||
* Readme: Corrected PowerShell environment variable example (#252, @gimre)
|
||||
* Misc: Removed yarn lock file from source control (#321, @fengmk2)
|
||||
|
||||
2.3.0 / 2016-11-07
|
||||
==================
|
||||
|
||||
* Fix: Consistent placement of ms diff at end of output (#215, @gorangajic)
|
||||
* Fix: Escaping of regex special characters in namespace strings (#250, @zacronos)
|
||||
* Fix: Fixed bug causing crash on react-native (#282, @vkarpov15)
|
||||
* Feature: Enabled ES6+ compatible import via default export (#212 @bucaran)
|
||||
* Feature: Added %O formatter to reflect Chrome's console.log capability (#279, @oncletom)
|
||||
* Package: Update "ms" to 0.7.2 (#315, @DevSide)
|
||||
* Package: removed superfluous version property from bower.json (#207 @kkirsche)
|
||||
* Readme: fix USE_COLORS to DEBUG_COLORS
|
||||
* Readme: Doc fixes for format string sugar (#269, @mlucool)
|
||||
* Readme: Updated docs for DEBUG_FD and DEBUG_COLORS environment variables (#232, @mattlyons0)
|
||||
* Readme: doc fixes for PowerShell (#271 #243, @exoticknight @unreadable)
|
||||
* Readme: better docs for browser support (#224, @matthewmueller)
|
||||
* Tooling: Added yarn integration for development (#317, @thebigredgeek)
|
||||
* Misc: Renamed History.md to CHANGELOG.md (@thebigredgeek)
|
||||
* Misc: Added license file (#226 #274, @CantemoInternal @sdaitzman)
|
||||
* Misc: Updated contributors (@thebigredgeek)
|
||||
|
||||
2.2.0 / 2015-05-09
|
||||
==================
|
||||
|
||||
* package: update "ms" to v0.7.1 (#202, @dougwilson)
|
||||
* README: add logging to file example (#193, @DanielOchoa)
|
||||
* README: fixed a typo (#191, @amir-s)
|
||||
* browser: expose `storage` (#190, @stephenmathieson)
|
||||
* Makefile: add a `distclean` target (#189, @stephenmathieson)
|
||||
|
||||
2.1.3 / 2015-03-13
|
||||
==================
|
||||
|
||||
* Updated stdout/stderr example (#186)
|
||||
* Updated example/stdout.js to match debug current behaviour
|
||||
* Renamed example/stderr.js to stdout.js
|
||||
* Update Readme.md (#184)
|
||||
* replace high intensity foreground color for bold (#182, #183)
|
||||
|
||||
2.1.2 / 2015-03-01
|
||||
==================
|
||||
|
||||
* dist: recompile
|
||||
* update "ms" to v0.7.0
|
||||
* package: update "browserify" to v9.0.3
|
||||
* component: fix "ms.js" repo location
|
||||
* changed bower package name
|
||||
* updated documentation about using debug in a browser
|
||||
* fix: security error on safari (#167, #168, @yields)
|
||||
|
||||
2.1.1 / 2014-12-29
|
||||
==================
|
||||
|
||||
* browser: use `typeof` to check for `console` existence
|
||||
* browser: check for `console.log` truthiness (fix IE 8/9)
|
||||
* browser: add support for Chrome apps
|
||||
* Readme: added Windows usage remarks
|
||||
* Add `bower.json` to properly support bower install
|
||||
|
||||
2.1.0 / 2014-10-15
|
||||
==================
|
||||
|
||||
* node: implement `DEBUG_FD` env variable support
|
||||
* package: update "browserify" to v6.1.0
|
||||
* package: add "license" field to package.json (#135, @panuhorsmalahti)
|
||||
|
||||
2.0.0 / 2014-09-01
|
||||
==================
|
||||
|
||||
* package: update "browserify" to v5.11.0
|
||||
* node: use stderr rather than stdout for logging (#29, @stephenmathieson)
|
||||
|
||||
1.0.4 / 2014-07-15
|
||||
==================
|
||||
|
||||
* dist: recompile
|
||||
* example: remove `console.info()` log usage
|
||||
* example: add "Content-Type" UTF-8 header to browser example
|
||||
* browser: place %c marker after the space character
|
||||
* browser: reset the "content" color via `color: inherit`
|
||||
* browser: add colors support for Firefox >= v31
|
||||
* debug: prefer an instance `log()` function over the global one (#119)
|
||||
* Readme: update documentation about styled console logs for FF v31 (#116, @wryk)
|
||||
|
||||
1.0.3 / 2014-07-09
|
||||
==================
|
||||
|
||||
* Add support for multiple wildcards in namespaces (#122, @seegno)
|
||||
* browser: fix lint
|
||||
|
||||
1.0.2 / 2014-06-10
|
||||
==================
|
||||
|
||||
* browser: update color palette (#113, @gscottolson)
|
||||
* common: make console logging function configurable (#108, @timoxley)
|
||||
* node: fix %o colors on old node <= 0.8.x
|
||||
* Makefile: find node path using shell/which (#109, @timoxley)
|
||||
|
||||
1.0.1 / 2014-06-06
|
||||
==================
|
||||
|
||||
* browser: use `removeItem()` to clear localStorage
|
||||
* browser, node: don't set DEBUG if namespaces is undefined (#107, @leedm777)
|
||||
* package: add "contributors" section
|
||||
* node: fix comment typo
|
||||
* README: list authors
|
||||
|
||||
1.0.0 / 2014-06-04
|
||||
==================
|
||||
|
||||
* make ms diff be global, not be scope
|
||||
* debug: ignore empty strings in enable()
|
||||
* node: make DEBUG_COLORS able to disable coloring
|
||||
* *: export the `colors` array
|
||||
* npmignore: don't publish the `dist` dir
|
||||
* Makefile: refactor to use browserify
|
||||
* package: add "browserify" as a dev dependency
|
||||
* Readme: add Web Inspector Colors section
|
||||
* node: reset terminal color for the debug content
|
||||
* node: map "%o" to `util.inspect()`
|
||||
* browser: map "%j" to `JSON.stringify()`
|
||||
* debug: add custom "formatters"
|
||||
* debug: use "ms" module for humanizing the diff
|
||||
* Readme: add "bash" syntax highlighting
|
||||
* browser: add Firebug color support
|
||||
* browser: add colors for WebKit browsers
|
||||
* node: apply log to `console`
|
||||
* rewrite: abstract common logic for Node & browsers
|
||||
* add .jshintrc file
|
||||
|
||||
0.8.1 / 2014-04-14
|
||||
==================
|
||||
|
||||
* package: re-add the "component" section
|
||||
|
||||
0.8.0 / 2014-03-30
|
||||
==================
|
||||
|
||||
* add `enable()` method for nodejs. Closes #27
|
||||
* change from stderr to stdout
|
||||
* remove unnecessary index.js file
|
||||
|
||||
0.7.4 / 2013-11-13
|
||||
==================
|
||||
|
||||
* remove "browserify" key from package.json (fixes something in browserify)
|
||||
|
||||
0.7.3 / 2013-10-30
|
||||
==================
|
||||
|
||||
* fix: catch localStorage security error when cookies are blocked (Chrome)
|
||||
* add debug(err) support. Closes #46
|
||||
* add .browser prop to package.json. Closes #42
|
||||
|
||||
0.7.2 / 2013-02-06
|
||||
==================
|
||||
|
||||
* fix package.json
|
||||
* fix: Mobile Safari (private mode) is broken with debug
|
||||
* fix: Use unicode to send escape character to shell instead of octal to work with strict mode javascript
|
||||
|
||||
0.7.1 / 2013-02-05
|
||||
==================
|
||||
|
||||
* add repository URL to package.json
|
||||
* add DEBUG_COLORED to force colored output
|
||||
* add browserify support
|
||||
* fix component. Closes #24
|
||||
|
||||
0.7.0 / 2012-05-04
|
||||
==================
|
||||
|
||||
* Added .component to package.json
|
||||
* Added debug.component.js build
|
||||
|
||||
0.6.0 / 2012-03-16
|
||||
==================
|
||||
|
||||
* Added support for "-" prefix in DEBUG [Vinay Pulim]
|
||||
* Added `.enabled` flag to the node version [TooTallNate]
|
||||
|
||||
0.5.0 / 2012-02-02
|
||||
==================
|
||||
|
||||
* Added: humanize diffs. Closes #8
|
||||
* Added `debug.disable()` to the CS variant
|
||||
* Removed padding. Closes #10
|
||||
* Fixed: persist client-side variant again. Closes #9
|
||||
|
||||
0.4.0 / 2012-02-01
|
||||
==================
|
||||
|
||||
* Added browser variant support for older browsers [TooTallNate]
|
||||
* Added `debug.enable('project:*')` to browser variant [TooTallNate]
|
||||
* Added padding to diff (moved it to the right)
|
||||
|
||||
0.3.0 / 2012-01-26
|
||||
==================
|
||||
|
||||
* Added millisecond diff when isatty, otherwise UTC string
|
||||
|
||||
0.2.0 / 2012-01-22
|
||||
==================
|
||||
|
||||
* Added wildcard support
|
||||
|
||||
0.1.0 / 2011-12-02
|
||||
==================
|
||||
|
||||
* Added: remove colors unless stderr isatty [TooTallNate]
|
||||
|
||||
0.0.1 / 2010-01-03
|
||||
==================
|
||||
|
||||
* Initial release
|
||||
+19
@@ -0,0 +1,19 @@
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2014 TJ Holowaychuk <tj@vision-media.ca>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software
|
||||
and associated documentation files (the 'Software'), to deal in the Software without restriction,
|
||||
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||||
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial
|
||||
portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
||||
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
+58
@@ -0,0 +1,58 @@
|
||||
# get Makefile directory name: http://stackoverflow.com/a/5982798/376773
|
||||
THIS_MAKEFILE_PATH:=$(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
|
||||
THIS_DIR:=$(shell cd $(dir $(THIS_MAKEFILE_PATH));pwd)
|
||||
|
||||
# BIN directory
|
||||
BIN := $(THIS_DIR)/node_modules/.bin
|
||||
|
||||
# Path
|
||||
PATH := node_modules/.bin:$(PATH)
|
||||
SHELL := /bin/bash
|
||||
|
||||
# applications
|
||||
NODE ?= $(shell which node)
|
||||
YARN ?= $(shell which yarn)
|
||||
PKG ?= $(if $(YARN),$(YARN),$(NODE) $(shell which npm))
|
||||
BROWSERIFY ?= $(NODE) $(BIN)/browserify
|
||||
|
||||
install: node_modules
|
||||
|
||||
browser: dist/debug.js
|
||||
|
||||
node_modules: package.json
|
||||
@NODE_ENV= $(PKG) install
|
||||
@touch node_modules
|
||||
|
||||
dist/debug.js: src/*.js node_modules
|
||||
@mkdir -p dist
|
||||
@$(BROWSERIFY) \
|
||||
--standalone debug \
|
||||
. > dist/debug.js
|
||||
|
||||
lint:
|
||||
@eslint *.js src/*.js
|
||||
|
||||
test-node:
|
||||
@istanbul cover node_modules/mocha/bin/_mocha -- test/**.js
|
||||
@cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
|
||||
|
||||
test-browser:
|
||||
@$(MAKE) browser
|
||||
@karma start --single-run
|
||||
|
||||
test-all:
|
||||
@concurrently \
|
||||
"make test-node" \
|
||||
"make test-browser"
|
||||
|
||||
test:
|
||||
@if [ "x$(BROWSER)" = "x" ]; then \
|
||||
$(MAKE) test-node; \
|
||||
else \
|
||||
$(MAKE) test-browser; \
|
||||
fi
|
||||
|
||||
clean:
|
||||
rimraf dist coverage
|
||||
|
||||
.PHONY: browser install clean lint test test-all test-node test-browser
|
||||
+368
@@ -0,0 +1,368 @@
|
||||
# debug
|
||||
[](https://travis-ci.org/visionmedia/debug) [](https://coveralls.io/github/visionmedia/debug?branch=master) [](https://visionmedia-community-slackin.now.sh/) [](#backers)
|
||||
[](#sponsors)
|
||||
|
||||
<img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png">
|
||||
|
||||
A tiny JavaScript debugging utility modelled after Node.js core's debugging
|
||||
technique. Works in Node.js and web browsers.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
$ npm install debug
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
`debug` exposes a function; simply pass this function the name of your module, and it will return a decorated version of `console.error` for you to pass debug statements to. This will allow you to toggle the debug output for different parts of your module as well as the module as a whole.
|
||||
|
||||
Example [_app.js_](./examples/node/app.js):
|
||||
|
||||
```js
|
||||
var debug = require('debug')('http')
|
||||
, http = require('http')
|
||||
, name = 'My App';
|
||||
|
||||
// fake app
|
||||
|
||||
debug('booting %o', name);
|
||||
|
||||
http.createServer(function(req, res){
|
||||
debug(req.method + ' ' + req.url);
|
||||
res.end('hello\n');
|
||||
}).listen(3000, function(){
|
||||
debug('listening');
|
||||
});
|
||||
|
||||
// fake worker of some kind
|
||||
|
||||
require('./worker');
|
||||
```
|
||||
|
||||
Example [_worker.js_](./examples/node/worker.js):
|
||||
|
||||
```js
|
||||
var a = require('debug')('worker:a')
|
||||
, b = require('debug')('worker:b');
|
||||
|
||||
function work() {
|
||||
a('doing lots of uninteresting work');
|
||||
setTimeout(work, Math.random() * 1000);
|
||||
}
|
||||
|
||||
work();
|
||||
|
||||
function workb() {
|
||||
b('doing some work');
|
||||
setTimeout(workb, Math.random() * 2000);
|
||||
}
|
||||
|
||||
workb();
|
||||
```
|
||||
|
||||
The `DEBUG` environment variable is then used to enable these based on space or
|
||||
comma-delimited names.
|
||||
|
||||
Here are some examples:
|
||||
|
||||
<img width="647" alt="screen shot 2017-08-08 at 12 53 04 pm" src="https://user-images.githubusercontent.com/71256/29091703-a6302cdc-7c38-11e7-8304-7c0b3bc600cd.png">
|
||||
<img width="647" alt="screen shot 2017-08-08 at 12 53 38 pm" src="https://user-images.githubusercontent.com/71256/29091700-a62a6888-7c38-11e7-800b-db911291ca2b.png">
|
||||
<img width="647" alt="screen shot 2017-08-08 at 12 53 25 pm" src="https://user-images.githubusercontent.com/71256/29091701-a62ea114-7c38-11e7-826a-2692bedca740.png">
|
||||
|
||||
#### Windows note
|
||||
|
||||
On Windows the environment variable is set using the `set` command.
|
||||
|
||||
```cmd
|
||||
set DEBUG=*,-not_this
|
||||
```
|
||||
|
||||
Note that PowerShell uses different syntax to set environment variables.
|
||||
|
||||
```cmd
|
||||
$env:DEBUG = "*,-not_this"
|
||||
```
|
||||
|
||||
Then, run the program to be debugged as usual.
|
||||
|
||||
|
||||
## Namespace Colors
|
||||
|
||||
Every debug instance has a color generated for it based on its namespace name.
|
||||
This helps when visually parsing the debug output to identify which debug instance
|
||||
a debug line belongs to.
|
||||
|
||||
#### Node.js
|
||||
|
||||
In Node.js, colors are enabled when stderr is a TTY. You also _should_ install
|
||||
the [`supports-color`](https://npmjs.org/supports-color) module alongside debug,
|
||||
otherwise debug will only use a small handful of basic colors.
|
||||
|
||||
<img width="521" src="https://user-images.githubusercontent.com/71256/29092181-47f6a9e6-7c3a-11e7-9a14-1928d8a711cd.png">
|
||||
|
||||
#### Web Browser
|
||||
|
||||
Colors are also enabled on "Web Inspectors" that understand the `%c` formatting
|
||||
option. These are WebKit web inspectors, Firefox ([since version
|
||||
31](https://hacks.mozilla.org/2014/05/editable-box-model-multiple-selection-sublime-text-keys-much-more-firefox-developer-tools-episode-31/))
|
||||
and the Firebug plugin for Firefox (any version).
|
||||
|
||||
<img width="524" src="https://user-images.githubusercontent.com/71256/29092033-b65f9f2e-7c39-11e7-8e32-f6f0d8e865c1.png">
|
||||
|
||||
|
||||
## Millisecond diff
|
||||
|
||||
When actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the "+NNNms" will show you how much time was spent between calls.
|
||||
|
||||
<img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png">
|
||||
|
||||
When stdout is not a TTY, `Date#toISOString()` is used, making it more useful for logging the debug information as shown below:
|
||||
|
||||
<img width="647" src="https://user-images.githubusercontent.com/71256/29091956-6bd78372-7c39-11e7-8c55-c948396d6edd.png">
|
||||
|
||||
|
||||
## Conventions
|
||||
|
||||
If you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use ":" to separate features. For example "bodyParser" from Connect would then be "connect:bodyParser". If you append a "*" to the end of your name, it will always be enabled regardless of the setting of the DEBUG environment variable. You can then use it for normal output as well as debug output.
|
||||
|
||||
## Wildcards
|
||||
|
||||
The `*` character may be used as a wildcard. Suppose for example your library has
|
||||
debuggers named "connect:bodyParser", "connect:compress", "connect:session",
|
||||
instead of listing all three with
|
||||
`DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do
|
||||
`DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`.
|
||||
|
||||
You can also exclude specific debuggers by prefixing them with a "-" character.
|
||||
For example, `DEBUG=*,-connect:*` would include all debuggers except those
|
||||
starting with "connect:".
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When running through Node.js, you can set a few environment variables that will
|
||||
change the behavior of the debug logging:
|
||||
|
||||
| Name | Purpose |
|
||||
|-----------|-------------------------------------------------|
|
||||
| `DEBUG` | Enables/disables specific debugging namespaces. |
|
||||
| `DEBUG_HIDE_DATE` | Hide date from debug output (non-TTY). |
|
||||
| `DEBUG_COLORS`| Whether or not to use colors in the debug output. |
|
||||
| `DEBUG_DEPTH` | Object inspection depth. |
|
||||
| `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. |
|
||||
|
||||
|
||||
__Note:__ The environment variables beginning with `DEBUG_` end up being
|
||||
converted into an Options object that gets used with `%o`/`%O` formatters.
|
||||
See the Node.js documentation for
|
||||
[`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options)
|
||||
for the complete list.
|
||||
|
||||
## Formatters
|
||||
|
||||
Debug uses [printf-style](https://wikipedia.org/wiki/Printf_format_string) formatting.
|
||||
Below are the officially supported formatters:
|
||||
|
||||
| Formatter | Representation |
|
||||
|-----------|----------------|
|
||||
| `%O` | Pretty-print an Object on multiple lines. |
|
||||
| `%o` | Pretty-print an Object all on a single line. |
|
||||
| `%s` | String. |
|
||||
| `%d` | Number (both integer and float). |
|
||||
| `%j` | JSON. Replaced with the string '[Circular]' if the argument contains circular references. |
|
||||
| `%%` | Single percent sign ('%'). This does not consume an argument. |
|
||||
|
||||
|
||||
### Custom formatters
|
||||
|
||||
You can add custom formatters by extending the `debug.formatters` object.
|
||||
For example, if you wanted to add support for rendering a Buffer as hex with
|
||||
`%h`, you could do something like:
|
||||
|
||||
```js
|
||||
const createDebug = require('debug')
|
||||
createDebug.formatters.h = (v) => {
|
||||
return v.toString('hex')
|
||||
}
|
||||
|
||||
// …elsewhere
|
||||
const debug = createDebug('foo')
|
||||
debug('this is hex: %h', new Buffer('hello world'))
|
||||
// foo this is hex: 68656c6c6f20776f726c6421 +0ms
|
||||
```
|
||||
|
||||
|
||||
## Browser Support
|
||||
|
||||
You can build a browser-ready script using [browserify](https://github.com/substack/node-browserify),
|
||||
or just use the [browserify-as-a-service](https://wzrd.in/) [build](https://wzrd.in/standalone/debug@latest),
|
||||
if you don't want to build it yourself.
|
||||
|
||||
Debug's enable state is currently persisted by `localStorage`.
|
||||
Consider the situation shown below where you have `worker:a` and `worker:b`,
|
||||
and wish to debug both. You can enable this using `localStorage.debug`:
|
||||
|
||||
```js
|
||||
localStorage.debug = 'worker:*'
|
||||
```
|
||||
|
||||
And then refresh the page.
|
||||
|
||||
```js
|
||||
a = debug('worker:a');
|
||||
b = debug('worker:b');
|
||||
|
||||
setInterval(function(){
|
||||
a('doing some work');
|
||||
}, 1000);
|
||||
|
||||
setInterval(function(){
|
||||
b('doing some work');
|
||||
}, 1200);
|
||||
```
|
||||
|
||||
|
||||
## Output streams
|
||||
|
||||
By default `debug` will log to stderr, however this can be configured per-namespace by overriding the `log` method:
|
||||
|
||||
Example [_stdout.js_](./examples/node/stdout.js):
|
||||
|
||||
```js
|
||||
var debug = require('debug');
|
||||
var error = debug('app:error');
|
||||
|
||||
// by default stderr is used
|
||||
error('goes to stderr!');
|
||||
|
||||
var log = debug('app:log');
|
||||
// set this namespace to log via console.log
|
||||
log.log = console.log.bind(console); // don't forget to bind to console!
|
||||
log('goes to stdout');
|
||||
error('still goes to stderr!');
|
||||
|
||||
// set all output to go via console.info
|
||||
// overrides all per-namespace log settings
|
||||
debug.log = console.info.bind(console);
|
||||
error('now goes to stdout via console.info');
|
||||
log('still goes to stdout, but via console.info now');
|
||||
```
|
||||
|
||||
## Checking whether a debug target is enabled
|
||||
|
||||
After you've created a debug instance, you can determine whether or not it is
|
||||
enabled by checking the `enabled` property:
|
||||
|
||||
```javascript
|
||||
const debug = require('debug')('http');
|
||||
|
||||
if (debug.enabled) {
|
||||
// do stuff...
|
||||
}
|
||||
```
|
||||
|
||||
You can also manually toggle this property to force the debug instance to be
|
||||
enabled or disabled.
|
||||
|
||||
|
||||
## Authors
|
||||
|
||||
- TJ Holowaychuk
|
||||
- Nathan Rajlich
|
||||
- Andrew Rhyne
|
||||
|
||||
## Backers
|
||||
|
||||
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/debug#backer)]
|
||||
|
||||
<a href="https://opencollective.com/debug/backer/0/website" target="_blank"><img src="https://opencollective.com/debug/backer/0/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/1/website" target="_blank"><img src="https://opencollective.com/debug/backer/1/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/2/website" target="_blank"><img src="https://opencollective.com/debug/backer/2/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/3/website" target="_blank"><img src="https://opencollective.com/debug/backer/3/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/4/website" target="_blank"><img src="https://opencollective.com/debug/backer/4/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/5/website" target="_blank"><img src="https://opencollective.com/debug/backer/5/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/6/website" target="_blank"><img src="https://opencollective.com/debug/backer/6/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/7/website" target="_blank"><img src="https://opencollective.com/debug/backer/7/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/8/website" target="_blank"><img src="https://opencollective.com/debug/backer/8/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/9/website" target="_blank"><img src="https://opencollective.com/debug/backer/9/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/10/website" target="_blank"><img src="https://opencollective.com/debug/backer/10/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/11/website" target="_blank"><img src="https://opencollective.com/debug/backer/11/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/12/website" target="_blank"><img src="https://opencollective.com/debug/backer/12/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/13/website" target="_blank"><img src="https://opencollective.com/debug/backer/13/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/14/website" target="_blank"><img src="https://opencollective.com/debug/backer/14/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/15/website" target="_blank"><img src="https://opencollective.com/debug/backer/15/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/16/website" target="_blank"><img src="https://opencollective.com/debug/backer/16/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/17/website" target="_blank"><img src="https://opencollective.com/debug/backer/17/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/18/website" target="_blank"><img src="https://opencollective.com/debug/backer/18/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/19/website" target="_blank"><img src="https://opencollective.com/debug/backer/19/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/20/website" target="_blank"><img src="https://opencollective.com/debug/backer/20/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/21/website" target="_blank"><img src="https://opencollective.com/debug/backer/21/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/22/website" target="_blank"><img src="https://opencollective.com/debug/backer/22/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/23/website" target="_blank"><img src="https://opencollective.com/debug/backer/23/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/24/website" target="_blank"><img src="https://opencollective.com/debug/backer/24/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/25/website" target="_blank"><img src="https://opencollective.com/debug/backer/25/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/26/website" target="_blank"><img src="https://opencollective.com/debug/backer/26/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/27/website" target="_blank"><img src="https://opencollective.com/debug/backer/27/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/28/website" target="_blank"><img src="https://opencollective.com/debug/backer/28/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/backer/29/website" target="_blank"><img src="https://opencollective.com/debug/backer/29/avatar.svg"></a>
|
||||
|
||||
|
||||
## Sponsors
|
||||
|
||||
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/debug#sponsor)]
|
||||
|
||||
<a href="https://opencollective.com/debug/sponsor/0/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/0/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/1/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/1/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/2/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/2/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/3/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/3/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/4/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/4/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/5/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/5/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/6/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/6/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/7/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/7/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/8/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/8/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/9/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/9/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/10/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/10/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/11/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/11/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/12/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/12/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/13/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/13/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/14/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/14/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/15/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/15/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/16/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/16/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/17/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/17/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/18/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/18/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/19/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/19/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/20/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/20/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/21/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/21/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/22/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/22/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/23/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/23/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/24/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/24/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/25/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/25/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/26/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/26/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/27/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/27/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/28/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/28/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/debug/sponsor/29/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/29/avatar.svg"></a>
|
||||
|
||||
## License
|
||||
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2014-2017 TJ Holowaychuk <tj@vision-media.ca>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
'Software'), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
+70
@@ -0,0 +1,70 @@
|
||||
// Karma configuration
|
||||
// Generated on Fri Dec 16 2016 13:09:51 GMT+0000 (UTC)
|
||||
|
||||
module.exports = function(config) {
|
||||
config.set({
|
||||
|
||||
// base path that will be used to resolve all patterns (eg. files, exclude)
|
||||
basePath: '',
|
||||
|
||||
|
||||
// frameworks to use
|
||||
// available frameworks: https://npmjs.org/browse/keyword/karma-adapter
|
||||
frameworks: ['mocha', 'chai', 'sinon'],
|
||||
|
||||
|
||||
// list of files / patterns to load in the browser
|
||||
files: [
|
||||
'dist/debug.js',
|
||||
'test/*spec.js'
|
||||
],
|
||||
|
||||
|
||||
// list of files to exclude
|
||||
exclude: [
|
||||
'src/node.js'
|
||||
],
|
||||
|
||||
|
||||
// preprocess matching files before serving them to the browser
|
||||
// available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
|
||||
preprocessors: {
|
||||
},
|
||||
|
||||
// test results reporter to use
|
||||
// possible values: 'dots', 'progress'
|
||||
// available reporters: https://npmjs.org/browse/keyword/karma-reporter
|
||||
reporters: ['progress'],
|
||||
|
||||
|
||||
// web server port
|
||||
port: 9876,
|
||||
|
||||
|
||||
// enable / disable colors in the output (reporters and logs)
|
||||
colors: true,
|
||||
|
||||
|
||||
// level of logging
|
||||
// possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
|
||||
logLevel: config.LOG_INFO,
|
||||
|
||||
|
||||
// enable / disable watching file and executing tests whenever any file changes
|
||||
autoWatch: true,
|
||||
|
||||
|
||||
// start these browsers
|
||||
// available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
|
||||
browsers: ['PhantomJS'],
|
||||
|
||||
|
||||
// Continuous Integration mode
|
||||
// if true, Karma captures browsers, runs the tests and exits
|
||||
singleRun: false,
|
||||
|
||||
// Concurrency level
|
||||
// how many browser should be started simultaneous
|
||||
concurrency: Infinity
|
||||
})
|
||||
}
|
||||
+1
@@ -0,0 +1 @@
|
||||
module.exports = require('./src/node');
|
||||
+82
@@ -0,0 +1,82 @@
|
||||
{
|
||||
"_from": "debug@^3.1.0",
|
||||
"_id": "debug@3.1.0",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==",
|
||||
"_location": "/debug",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"type": "range",
|
||||
"registry": true,
|
||||
"raw": "debug@^3.1.0",
|
||||
"name": "debug",
|
||||
"escapedName": "debug",
|
||||
"rawSpec": "^3.1.0",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "^3.1.0"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/@octokit/rest"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz",
|
||||
"_shasum": "5bb5a0672628b64149566ba16819e61518c67261",
|
||||
"_spec": "debug@^3.1.0",
|
||||
"_where": "C:\\Users\\Luis\\source\\repos\\AAWebPlatform\\node_modules\\@octokit\\rest",
|
||||
"author": {
|
||||
"name": "TJ Holowaychuk",
|
||||
"email": "tj@vision-media.ca"
|
||||
},
|
||||
"browser": "./src/browser.js",
|
||||
"bugs": {
|
||||
"url": "https://github.com/visionmedia/debug/issues"
|
||||
},
|
||||
"bundleDependencies": false,
|
||||
"contributors": [
|
||||
{
|
||||
"name": "Nathan Rajlich",
|
||||
"email": "nathan@tootallnate.net",
|
||||
"url": "http://n8.io"
|
||||
},
|
||||
{
|
||||
"name": "Andrew Rhyne",
|
||||
"email": "rhyneandrew@gmail.com"
|
||||
}
|
||||
],
|
||||
"dependencies": {
|
||||
"ms": "2.0.0"
|
||||
},
|
||||
"deprecated": false,
|
||||
"description": "small debugging utility",
|
||||
"devDependencies": {
|
||||
"browserify": "14.4.0",
|
||||
"chai": "^3.5.0",
|
||||
"concurrently": "^3.1.0",
|
||||
"coveralls": "^2.11.15",
|
||||
"eslint": "^3.12.1",
|
||||
"istanbul": "^0.4.5",
|
||||
"karma": "^1.3.0",
|
||||
"karma-chai": "^0.1.0",
|
||||
"karma-mocha": "^1.3.0",
|
||||
"karma-phantomjs-launcher": "^1.0.2",
|
||||
"karma-sinon": "^1.0.5",
|
||||
"mocha": "^3.2.0",
|
||||
"mocha-lcov-reporter": "^1.2.0",
|
||||
"rimraf": "^2.5.4",
|
||||
"sinon": "^1.17.6",
|
||||
"sinon-chai": "^2.8.0"
|
||||
},
|
||||
"homepage": "https://github.com/visionmedia/debug#readme",
|
||||
"keywords": [
|
||||
"debug",
|
||||
"log",
|
||||
"debugger"
|
||||
],
|
||||
"license": "MIT",
|
||||
"main": "./src/index.js",
|
||||
"name": "debug",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git://github.com/visionmedia/debug.git"
|
||||
},
|
||||
"version": "3.1.0"
|
||||
}
|
||||
+195
@@ -0,0 +1,195 @@
|
||||
/**
|
||||
* This is the web browser implementation of `debug()`.
|
||||
*
|
||||
* Expose `debug()` as the module.
|
||||
*/
|
||||
|
||||
exports = module.exports = require('./debug');
|
||||
exports.log = log;
|
||||
exports.formatArgs = formatArgs;
|
||||
exports.save = save;
|
||||
exports.load = load;
|
||||
exports.useColors = useColors;
|
||||
exports.storage = 'undefined' != typeof chrome
|
||||
&& 'undefined' != typeof chrome.storage
|
||||
? chrome.storage.local
|
||||
: localstorage();
|
||||
|
||||
/**
|
||||
* Colors.
|
||||
*/
|
||||
|
||||
exports.colors = [
|
||||
'#0000CC', '#0000FF', '#0033CC', '#0033FF', '#0066CC', '#0066FF', '#0099CC',
|
||||
'#0099FF', '#00CC00', '#00CC33', '#00CC66', '#00CC99', '#00CCCC', '#00CCFF',
|
||||
'#3300CC', '#3300FF', '#3333CC', '#3333FF', '#3366CC', '#3366FF', '#3399CC',
|
||||
'#3399FF', '#33CC00', '#33CC33', '#33CC66', '#33CC99', '#33CCCC', '#33CCFF',
|
||||
'#6600CC', '#6600FF', '#6633CC', '#6633FF', '#66CC00', '#66CC33', '#9900CC',
|
||||
'#9900FF', '#9933CC', '#9933FF', '#99CC00', '#99CC33', '#CC0000', '#CC0033',
|
||||
'#CC0066', '#CC0099', '#CC00CC', '#CC00FF', '#CC3300', '#CC3333', '#CC3366',
|
||||
'#CC3399', '#CC33CC', '#CC33FF', '#CC6600', '#CC6633', '#CC9900', '#CC9933',
|
||||
'#CCCC00', '#CCCC33', '#FF0000', '#FF0033', '#FF0066', '#FF0099', '#FF00CC',
|
||||
'#FF00FF', '#FF3300', '#FF3333', '#FF3366', '#FF3399', '#FF33CC', '#FF33FF',
|
||||
'#FF6600', '#FF6633', '#FF9900', '#FF9933', '#FFCC00', '#FFCC33'
|
||||
];
|
||||
|
||||
/**
|
||||
* Currently only WebKit-based Web Inspectors, Firefox >= v31,
|
||||
* and the Firebug extension (any Firefox version) are known
|
||||
* to support "%c" CSS customizations.
|
||||
*
|
||||
* TODO: add a `localStorage` variable to explicitly enable/disable colors
|
||||
*/
|
||||
|
||||
function useColors() {
|
||||
// NB: In an Electron preload script, document will be defined but not fully
|
||||
// initialized. Since we know we're in Chrome, we'll just detect this case
|
||||
// explicitly
|
||||
if (typeof window !== 'undefined' && window.process && window.process.type === 'renderer') {
|
||||
return true;
|
||||
}
|
||||
|
||||
// Internet Explorer and Edge do not support colors.
|
||||
if (typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/(edge|trident)\/(\d+)/)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// is webkit? http://stackoverflow.com/a/16459606/376773
|
||||
// document is undefined in react-native: https://github.com/facebook/react-native/pull/1632
|
||||
return (typeof document !== 'undefined' && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance) ||
|
||||
// is firebug? http://stackoverflow.com/a/398120/376773
|
||||
(typeof window !== 'undefined' && window.console && (window.console.firebug || (window.console.exception && window.console.table))) ||
|
||||
// is firefox >= v31?
|
||||
// https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Styling_messages
|
||||
(typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/firefox\/(\d+)/) && parseInt(RegExp.$1, 10) >= 31) ||
|
||||
// double check webkit in userAgent just in case we are in a worker
|
||||
(typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/applewebkit\/(\d+)/));
|
||||
}
|
||||
|
||||
/**
|
||||
* Map %j to `JSON.stringify()`, since no Web Inspectors do that by default.
|
||||
*/
|
||||
|
||||
exports.formatters.j = function(v) {
|
||||
try {
|
||||
return JSON.stringify(v);
|
||||
} catch (err) {
|
||||
return '[UnexpectedJSONParseError]: ' + err.message;
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Colorize log arguments if enabled.
|
||||
*
|
||||
* @api public
|
||||
*/
|
||||
|
||||
function formatArgs(args) {
|
||||
var useColors = this.useColors;
|
||||
|
||||
args[0] = (useColors ? '%c' : '')
|
||||
+ this.namespace
|
||||
+ (useColors ? ' %c' : ' ')
|
||||
+ args[0]
|
||||
+ (useColors ? '%c ' : ' ')
|
||||
+ '+' + exports.humanize(this.diff);
|
||||
|
||||
if (!useColors) return;
|
||||
|
||||
var c = 'color: ' + this.color;
|
||||
args.splice(1, 0, c, 'color: inherit')
|
||||
|
||||
// the final "%c" is somewhat tricky, because there could be other
|
||||
// arguments passed either before or after the %c, so we need to
|
||||
// figure out the correct index to insert the CSS into
|
||||
var index = 0;
|
||||
var lastC = 0;
|
||||
args[0].replace(/%[a-zA-Z%]/g, function(match) {
|
||||
if ('%%' === match) return;
|
||||
index++;
|
||||
if ('%c' === match) {
|
||||
// we only are interested in the *last* %c
|
||||
// (the user may have provided their own)
|
||||
lastC = index;
|
||||
}
|
||||
});
|
||||
|
||||
args.splice(lastC, 0, c);
|
||||
}
|
||||
|
||||
/**
|
||||
* Invokes `console.log()` when available.
|
||||
* No-op when `console.log` is not a "function".
|
||||
*
|
||||
* @api public
|
||||
*/
|
||||
|
||||
function log() {
|
||||
// this hackery is required for IE8/9, where
|
||||
// the `console.log` function doesn't have 'apply'
|
||||
return 'object' === typeof console
|
||||
&& console.log
|
||||
&& Function.prototype.apply.call(console.log, console, arguments);
|
||||
}
|
||||
|
||||
/**
|
||||
* Save `namespaces`.
|
||||
*
|
||||
* @param {String} namespaces
|
||||
* @api private
|
||||
*/
|
||||
|
||||
function save(namespaces) {
|
||||
try {
|
||||
if (null == namespaces) {
|
||||
exports.storage.removeItem('debug');
|
||||
} else {
|
||||
exports.storage.debug = namespaces;
|
||||
}
|
||||
} catch(e) {}
|
||||
}
|
||||
|
||||
/**
|
||||
* Load `namespaces`.
|
||||
*
|
||||
* @return {String} returns the previously persisted debug modes
|
||||
* @api private
|
||||
*/
|
||||
|
||||
function load() {
|
||||
var r;
|
||||
try {
|
||||
r = exports.storage.debug;
|
||||
} catch(e) {}
|
||||
|
||||
// If debug isn't set in LS, and we're in Electron, try to load $DEBUG
|
||||
if (!r && typeof process !== 'undefined' && 'env' in process) {
|
||||
r = process.env.DEBUG;
|
||||
}
|
||||
|
||||
return r;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable namespaces listed in `localStorage.debug` initially.
|
||||
*/
|
||||
|
||||
exports.enable(load());
|
||||
|
||||
/**
|
||||
* Localstorage attempts to return the localstorage.
|
||||
*
|
||||
* This is necessary because safari throws
|
||||
* when a user disables cookies/localstorage
|
||||
* and you attempt to access it.
|
||||
*
|
||||
* @return {LocalStorage}
|
||||
* @api private
|
||||
*/
|
||||
|
||||
function localstorage() {
|
||||
try {
|
||||
return window.localStorage;
|
||||
} catch (e) {}
|
||||
}
|
||||
+225
@@ -0,0 +1,225 @@
|
||||
|
||||
/**
|
||||
* This is the common logic for both the Node.js and web browser
|
||||
* implementations of `debug()`.
|
||||
*
|
||||
* Expose `debug()` as the module.
|
||||
*/
|
||||
|
||||
exports = module.exports = createDebug.debug = createDebug['default'] = createDebug;
|
||||
exports.coerce = coerce;
|
||||
exports.disable = disable;
|
||||
exports.enable = enable;
|
||||
exports.enabled = enabled;
|
||||
exports.humanize = require('ms');
|
||||
|
||||
/**
|
||||
* Active `debug` instances.
|
||||
*/
|
||||
exports.instances = [];
|
||||
|
||||
/**
|
||||
* The currently active debug mode names, and names to skip.
|
||||
*/
|
||||
|
||||
exports.names = [];
|
||||
exports.skips = [];
|
||||
|
||||
/**
|
||||
* Map of special "%n" handling functions, for the debug "format" argument.
|
||||
*
|
||||
* Valid key names are a single, lower or upper-case letter, i.e. "n" and "N".
|
||||
*/
|
||||
|
||||
exports.formatters = {};
|
||||
|
||||
/**
|
||||
* Select a color.
|
||||
* @param {String} namespace
|
||||
* @return {Number}
|
||||
* @api private
|
||||
*/
|
||||
|
||||
function selectColor(namespace) {
|
||||
var hash = 0, i;
|
||||
|
||||
for (i in namespace) {
|
||||
hash = ((hash << 5) - hash) + namespace.charCodeAt(i);
|
||||
hash |= 0; // Convert to 32bit integer
|
||||
}
|
||||
|
||||
return exports.colors[Math.abs(hash) % exports.colors.length];
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a debugger with the given `namespace`.
|
||||
*
|
||||
* @param {String} namespace
|
||||
* @return {Function}
|
||||
* @api public
|
||||
*/
|
||||
|
||||
function createDebug(namespace) {
|
||||
|
||||
var prevTime;
|
||||
|
||||
function debug() {
|
||||
// disabled?
|
||||
if (!debug.enabled) return;
|
||||
|
||||
var self = debug;
|
||||
|
||||
// set `diff` timestamp
|
||||
var curr = +new Date();
|
||||
var ms = curr - (prevTime || curr);
|
||||
self.diff = ms;
|
||||
self.prev = prevTime;
|
||||
self.curr = curr;
|
||||
prevTime = curr;
|
||||
|
||||
// turn the `arguments` into a proper Array
|
||||
var args = new Array(arguments.length);
|
||||
for (var i = 0; i < args.length; i++) {
|
||||
args[i] = arguments[i];
|
||||
}
|
||||
|
||||
args[0] = exports.coerce(args[0]);
|
||||
|
||||
if ('string' !== typeof args[0]) {
|
||||
// anything else let's inspect with %O
|
||||
args.unshift('%O');
|
||||
}
|
||||
|
||||
// apply any `formatters` transformations
|
||||
var index = 0;
|
||||
args[0] = args[0].replace(/%([a-zA-Z%])/g, function(match, format) {
|
||||
// if we encounter an escaped % then don't increase the array index
|
||||
if (match === '%%') return match;
|
||||
index++;
|
||||
var formatter = exports.formatters[format];
|
||||
if ('function' === typeof formatter) {
|
||||
var val = args[index];
|
||||
match = formatter.call(self, val);
|
||||
|
||||
// now we need to remove `args[index]` since it's inlined in the `format`
|
||||
args.splice(index, 1);
|
||||
index--;
|
||||
}
|
||||
return match;
|
||||
});
|
||||
|
||||
// apply env-specific formatting (colors, etc.)
|
||||
exports.formatArgs.call(self, args);
|
||||
|
||||
var logFn = debug.log || exports.log || console.log.bind(console);
|
||||
logFn.apply(self, args);
|
||||
}
|
||||
|
||||
debug.namespace = namespace;
|
||||
debug.enabled = exports.enabled(namespace);
|
||||
debug.useColors = exports.useColors();
|
||||
debug.color = selectColor(namespace);
|
||||
debug.destroy = destroy;
|
||||
|
||||
// env-specific initialization logic for debug instances
|
||||
if ('function' === typeof exports.init) {
|
||||
exports.init(debug);
|
||||
}
|
||||
|
||||
exports.instances.push(debug);
|
||||
|
||||
return debug;
|
||||
}
|
||||
|
||||
function destroy () {
|
||||
var index = exports.instances.indexOf(this);
|
||||
if (index !== -1) {
|
||||
exports.instances.splice(index, 1);
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables a debug mode by namespaces. This can include modes
|
||||
* separated by a colon and wildcards.
|
||||
*
|
||||
* @param {String} namespaces
|
||||
* @api public
|
||||
*/
|
||||
|
||||
function enable(namespaces) {
|
||||
exports.save(namespaces);
|
||||
|
||||
exports.names = [];
|
||||
exports.skips = [];
|
||||
|
||||
var i;
|
||||
var split = (typeof namespaces === 'string' ? namespaces : '').split(/[\s,]+/);
|
||||
var len = split.length;
|
||||
|
||||
for (i = 0; i < len; i++) {
|
||||
if (!split[i]) continue; // ignore empty strings
|
||||
namespaces = split[i].replace(/\*/g, '.*?');
|
||||
if (namespaces[0] === '-') {
|
||||
exports.skips.push(new RegExp('^' + namespaces.substr(1) + '$'));
|
||||
} else {
|
||||
exports.names.push(new RegExp('^' + namespaces + '$'));
|
||||
}
|
||||
}
|
||||
|
||||
for (i = 0; i < exports.instances.length; i++) {
|
||||
var instance = exports.instances[i];
|
||||
instance.enabled = exports.enabled(instance.namespace);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Disable debug output.
|
||||
*
|
||||
* @api public
|
||||
*/
|
||||
|
||||
function disable() {
|
||||
exports.enable('');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the given mode name is enabled, false otherwise.
|
||||
*
|
||||
* @param {String} name
|
||||
* @return {Boolean}
|
||||
* @api public
|
||||
*/
|
||||
|
||||
function enabled(name) {
|
||||
if (name[name.length - 1] === '*') {
|
||||
return true;
|
||||
}
|
||||
var i, len;
|
||||
for (i = 0, len = exports.skips.length; i < len; i++) {
|
||||
if (exports.skips[i].test(name)) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
for (i = 0, len = exports.names.length; i < len; i++) {
|
||||
if (exports.names[i].test(name)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Coerce `val`.
|
||||
*
|
||||
* @param {Mixed} val
|
||||
* @return {Mixed}
|
||||
* @api private
|
||||
*/
|
||||
|
||||
function coerce(val) {
|
||||
if (val instanceof Error) return val.stack || val.message;
|
||||
return val;
|
||||
}
|
||||
+10
@@ -0,0 +1,10 @@
|
||||
/**
|
||||
* Detect Electron renderer process, which is node, but we should
|
||||
* treat as a browser.
|
||||
*/
|
||||
|
||||
if (typeof process === 'undefined' || process.type === 'renderer') {
|
||||
module.exports = require('./browser.js');
|
||||
} else {
|
||||
module.exports = require('./node.js');
|
||||
}
|
||||
+186
@@ -0,0 +1,186 @@
|
||||
/**
|
||||
* Module dependencies.
|
||||
*/
|
||||
|
||||
var tty = require('tty');
|
||||
var util = require('util');
|
||||
|
||||
/**
|
||||
* This is the Node.js implementation of `debug()`.
|
||||
*
|
||||
* Expose `debug()` as the module.
|
||||
*/
|
||||
|
||||
exports = module.exports = require('./debug');
|
||||
exports.init = init;
|
||||
exports.log = log;
|
||||
exports.formatArgs = formatArgs;
|
||||
exports.save = save;
|
||||
exports.load = load;
|
||||
exports.useColors = useColors;
|
||||
|
||||
/**
|
||||
* Colors.
|
||||
*/
|
||||
|
||||
exports.colors = [ 6, 2, 3, 4, 5, 1 ];
|
||||
|
||||
try {
|
||||
var supportsColor = require('supports-color');
|
||||
if (supportsColor && supportsColor.level >= 2) {
|
||||
exports.colors = [
|
||||
20, 21, 26, 27, 32, 33, 38, 39, 40, 41, 42, 43, 44, 45, 56, 57, 62, 63, 68,
|
||||
69, 74, 75, 76, 77, 78, 79, 80, 81, 92, 93, 98, 99, 112, 113, 128, 129, 134,
|
||||
135, 148, 149, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171,
|
||||
172, 173, 178, 179, 184, 185, 196, 197, 198, 199, 200, 201, 202, 203, 204,
|
||||
205, 206, 207, 208, 209, 214, 215, 220, 221
|
||||
];
|
||||
}
|
||||
} catch (err) {
|
||||
// swallow - we only care if `supports-color` is available; it doesn't have to be.
|
||||
}
|
||||
|
||||
/**
|
||||
* Build up the default `inspectOpts` object from the environment variables.
|
||||
*
|
||||
* $ DEBUG_COLORS=no DEBUG_DEPTH=10 DEBUG_SHOW_HIDDEN=enabled node script.js
|
||||
*/
|
||||
|
||||
exports.inspectOpts = Object.keys(process.env).filter(function (key) {
|
||||
return /^debug_/i.test(key);
|
||||
}).reduce(function (obj, key) {
|
||||
// camel-case
|
||||
var prop = key
|
||||
.substring(6)
|
||||
.toLowerCase()
|
||||
.replace(/_([a-z])/g, function (_, k) { return k.toUpperCase() });
|
||||
|
||||
// coerce string value into JS value
|
||||
var val = process.env[key];
|
||||
if (/^(yes|on|true|enabled)$/i.test(val)) val = true;
|
||||
else if (/^(no|off|false|disabled)$/i.test(val)) val = false;
|
||||
else if (val === 'null') val = null;
|
||||
else val = Number(val);
|
||||
|
||||
obj[prop] = val;
|
||||
return obj;
|
||||
}, {});
|
||||
|
||||
/**
|
||||
* Is stdout a TTY? Colored output is enabled when `true`.
|
||||
*/
|
||||
|
||||
function useColors() {
|
||||
return 'colors' in exports.inspectOpts
|
||||
? Boolean(exports.inspectOpts.colors)
|
||||
: tty.isatty(process.stderr.fd);
|
||||
}
|
||||
|
||||
/**
|
||||
* Map %o to `util.inspect()`, all on a single line.
|
||||
*/
|
||||
|
||||
exports.formatters.o = function(v) {
|
||||
this.inspectOpts.colors = this.useColors;
|
||||
return util.inspect(v, this.inspectOpts)
|
||||
.split('\n').map(function(str) {
|
||||
return str.trim()
|
||||
}).join(' ');
|
||||
};
|
||||
|
||||
/**
|
||||
* Map %o to `util.inspect()`, allowing multiple lines if needed.
|
||||
*/
|
||||
|
||||
exports.formatters.O = function(v) {
|
||||
this.inspectOpts.colors = this.useColors;
|
||||
return util.inspect(v, this.inspectOpts);
|
||||
};
|
||||
|
||||
/**
|
||||
* Adds ANSI color escape codes if enabled.
|
||||
*
|
||||
* @api public
|
||||
*/
|
||||
|
||||
function formatArgs(args) {
|
||||
var name = this.namespace;
|
||||
var useColors = this.useColors;
|
||||
|
||||
if (useColors) {
|
||||
var c = this.color;
|
||||
var colorCode = '\u001b[3' + (c < 8 ? c : '8;5;' + c);
|
||||
var prefix = ' ' + colorCode + ';1m' + name + ' ' + '\u001b[0m';
|
||||
|
||||
args[0] = prefix + args[0].split('\n').join('\n' + prefix);
|
||||
args.push(colorCode + 'm+' + exports.humanize(this.diff) + '\u001b[0m');
|
||||
} else {
|
||||
args[0] = getDate() + name + ' ' + args[0];
|
||||
}
|
||||
}
|
||||
|
||||
function getDate() {
|
||||
if (exports.inspectOpts.hideDate) {
|
||||
return '';
|
||||
} else {
|
||||
return new Date().toISOString() + ' ';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Invokes `util.format()` with the specified arguments and writes to stderr.
|
||||
*/
|
||||
|
||||
function log() {
|
||||
return process.stderr.write(util.format.apply(util, arguments) + '\n');
|
||||
}
|
||||
|
||||
/**
|
||||
* Save `namespaces`.
|
||||
*
|
||||
* @param {String} namespaces
|
||||
* @api private
|
||||
*/
|
||||
|
||||
function save(namespaces) {
|
||||
if (null == namespaces) {
|
||||
// If you set a process.env field to null or undefined, it gets cast to the
|
||||
// string 'null' or 'undefined'. Just delete instead.
|
||||
delete process.env.DEBUG;
|
||||
} else {
|
||||
process.env.DEBUG = namespaces;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Load `namespaces`.
|
||||
*
|
||||
* @return {String} returns the previously persisted debug modes
|
||||
* @api private
|
||||
*/
|
||||
|
||||
function load() {
|
||||
return process.env.DEBUG;
|
||||
}
|
||||
|
||||
/**
|
||||
* Init logic for `debug` instances.
|
||||
*
|
||||
* Create a new `inspectOpts` object in case `useColors` is set
|
||||
* differently for a particular `debug` instance.
|
||||
*/
|
||||
|
||||
function init (debug) {
|
||||
debug.inspectOpts = {};
|
||||
|
||||
var keys = Object.keys(exports.inspectOpts);
|
||||
for (var i = 0; i < keys.length; i++) {
|
||||
debug.inspectOpts[keys[i]] = exports.inspectOpts[keys[i]];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable namespaces listed in `process.env.DEBUG` initially.
|
||||
*/
|
||||
|
||||
exports.enable(load());
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
# Changelog
|
||||
|
||||
## 1.0.0 (Jul 25, 2017)
|
||||
|
||||
Supports UMD, CommonJS and ES Module.
|
||||
|
||||
## 0.1.0 (Nov 28, 2015)
|
||||
|
||||
Check if ArrayBuffer is defined first.
|
||||
|
||||
## 0.0.1 (Nov 11, 2015)
|
||||
|
||||
Initial release.
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2015-2017 Chen Fengyuan
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
+35
@@ -0,0 +1,35 @@
|
||||
# is-array-buffer
|
||||
|
||||
> Check if the given value is an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer).
|
||||
|
||||
## Main
|
||||
|
||||
```txt
|
||||
dist/
|
||||
├── is-array-buffer.js (UMD)
|
||||
├── is-array-buffer.min.js (UMD, compressed)
|
||||
├── is-array-buffer.common.js (CommonJS, default)
|
||||
└── is-array-buffer.esm.js (ES Module)
|
||||
```
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
npm install --save is-array-buffer
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
import isArrayBuffer from 'is-array-buffer';
|
||||
|
||||
isArrayBuffer(new ArrayBuffer());
|
||||
// => true
|
||||
|
||||
isArrayBuffer(new Array());
|
||||
// => false
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
[MIT](http://opensource.org/licenses/MIT) © [Chen Fengyuan](http://chenfengyuan.com)
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
/*!
|
||||
* isArrayBuffer v1.0.0
|
||||
* https://github.com/fengyuanchen/is-array-buffer
|
||||
*
|
||||
* Copyright (c) 2015-2017 Chen Fengyuan
|
||||
* Released under the MIT license
|
||||
*
|
||||
* Date: 2017-07-26T11:00:44.931Z
|
||||
*/
|
||||
|
||||
'use strict';
|
||||
|
||||
var hasArrayBuffer = typeof ArrayBuffer === 'function';
|
||||
var toString = Object.prototype.toString;
|
||||
|
||||
/**
|
||||
* Check if the given value is an ArrayBuffer.
|
||||
* @param {*} value - The value to check.
|
||||
* @returns {boolean} Returns `true` if the given is an ArrayBuffer, else `false`.
|
||||
* @example
|
||||
* isArrayBuffer(new ArrayBuffer())
|
||||
* // => true
|
||||
* isArrayBuffer(new Array())
|
||||
* // => false
|
||||
*/
|
||||
function isArrayBuffer(value) {
|
||||
return hasArrayBuffer && (value instanceof ArrayBuffer || toString.call(value) === '[object ArrayBuffer]');
|
||||
}
|
||||
|
||||
module.exports = isArrayBuffer;
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
/*!
|
||||
* isArrayBuffer v1.0.0
|
||||
* https://github.com/fengyuanchen/is-array-buffer
|
||||
*
|
||||
* Copyright (c) 2015-2017 Chen Fengyuan
|
||||
* Released under the MIT license
|
||||
*
|
||||
* Date: 2017-07-26T11:00:44.931Z
|
||||
*/
|
||||
|
||||
var hasArrayBuffer = typeof ArrayBuffer === 'function';
|
||||
var toString = Object.prototype.toString;
|
||||
|
||||
/**
|
||||
* Check if the given value is an ArrayBuffer.
|
||||
* @param {*} value - The value to check.
|
||||
* @returns {boolean} Returns `true` if the given is an ArrayBuffer, else `false`.
|
||||
* @example
|
||||
* isArrayBuffer(new ArrayBuffer())
|
||||
* // => true
|
||||
* isArrayBuffer(new Array())
|
||||
* // => false
|
||||
*/
|
||||
function isArrayBuffer(value) {
|
||||
return hasArrayBuffer && (value instanceof ArrayBuffer || toString.call(value) === '[object ArrayBuffer]');
|
||||
}
|
||||
|
||||
export default isArrayBuffer;
|
||||
+36
@@ -0,0 +1,36 @@
|
||||
/*!
|
||||
* isArrayBuffer v1.0.0
|
||||
* https://github.com/fengyuanchen/is-array-buffer
|
||||
*
|
||||
* Copyright (c) 2015-2017 Chen Fengyuan
|
||||
* Released under the MIT license
|
||||
*
|
||||
* Date: 2017-07-26T11:00:44.931Z
|
||||
*/
|
||||
|
||||
(function (global, factory) {
|
||||
typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
|
||||
typeof define === 'function' && define.amd ? define(factory) :
|
||||
(global.isArrayBuffer = factory());
|
||||
}(this, (function () { 'use strict';
|
||||
|
||||
var hasArrayBuffer = typeof ArrayBuffer === 'function';
|
||||
var toString = Object.prototype.toString;
|
||||
|
||||
/**
|
||||
* Check if the given value is an ArrayBuffer.
|
||||
* @param {*} value - The value to check.
|
||||
* @returns {boolean} Returns `true` if the given is an ArrayBuffer, else `false`.
|
||||
* @example
|
||||
* isArrayBuffer(new ArrayBuffer())
|
||||
* // => true
|
||||
* isArrayBuffer(new Array())
|
||||
* // => false
|
||||
*/
|
||||
function isArrayBuffer(value) {
|
||||
return hasArrayBuffer && (value instanceof ArrayBuffer || toString.call(value) === '[object ArrayBuffer]');
|
||||
}
|
||||
|
||||
return isArrayBuffer;
|
||||
|
||||
})));
|
||||
+10
@@ -0,0 +1,10 @@
|
||||
/*!
|
||||
* isArrayBuffer v1.0.0
|
||||
* https://github.com/fengyuanchen/is-array-buffer
|
||||
*
|
||||
* Copyright (c) 2015-2017 Chen Fengyuan
|
||||
* Released under the MIT license
|
||||
*
|
||||
* Date: 2017-07-26T11:00:44.931Z
|
||||
*/
|
||||
!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.isArrayBuffer=t()}(this,function(){"use strict";var e="function"==typeof ArrayBuffer,t=Object.prototype.toString;return function(f){return e&&(f instanceof ArrayBuffer||"[object ArrayBuffer]"===t.call(f))}});
|
||||
+70
@@ -0,0 +1,70 @@
|
||||
{
|
||||
"_from": "is-array-buffer@^1.0.0",
|
||||
"_id": "is-array-buffer@1.0.0",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha512-KtzJzWuC1kZQ377GJbEsoBh0LuQh1uaZnQg8oL2LcDkY/Ny8rpAzu21Ls3oph3SEKXbnrLHt3rAUVm28iuEPfw==",
|
||||
"_location": "/is-array-buffer",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"type": "range",
|
||||
"registry": true,
|
||||
"raw": "is-array-buffer@^1.0.0",
|
||||
"name": "is-array-buffer",
|
||||
"escapedName": "is-array-buffer",
|
||||
"rawSpec": "^1.0.0",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "^1.0.0"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/@octokit/rest"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-1.0.0.tgz",
|
||||
"_shasum": "f32497a0509d109423f472003f98bab6a8ea34cb",
|
||||
"_spec": "is-array-buffer@^1.0.0",
|
||||
"_where": "C:\\Users\\Luis\\source\\repos\\AAWebPlatform\\node_modules\\@octokit\\rest",
|
||||
"author": {
|
||||
"name": "Chen Fengyuan",
|
||||
"url": "http://chenfengyuan.com"
|
||||
},
|
||||
"browser": "dist/is-array-buffer.js",
|
||||
"bugs": {
|
||||
"url": "https://github.com/fengyuanchen/is-array-buffer/issues"
|
||||
},
|
||||
"bundleDependencies": false,
|
||||
"deprecated": false,
|
||||
"description": "Check if the given value is an ArrayBuffer.",
|
||||
"devDependencies": {
|
||||
"babel-preset-env": "^1.6.0",
|
||||
"eslint": "^4.3.0",
|
||||
"eslint-config-airbnb-base": "^11.3.1",
|
||||
"eslint-plugin-import": "^2.7.0",
|
||||
"mocha": "^3.4.2",
|
||||
"rollup": "^0.45.2",
|
||||
"rollup-plugin-babel": "^2.7.1",
|
||||
"uglify-js": "^3.0.26"
|
||||
},
|
||||
"homepage": "https://github.com/fengyuanchen/is-array-buffer",
|
||||
"keywords": [
|
||||
"is",
|
||||
"array",
|
||||
"buffer",
|
||||
"ArrayBuffer"
|
||||
],
|
||||
"license": "MIT",
|
||||
"main": "dist/is-array-buffer.common.js",
|
||||
"module": "dist/is-array-buffer.esm.js",
|
||||
"name": "is-array-buffer",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/fengyuanchen/is-array-buffer.git"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "rollup -c",
|
||||
"compress": "uglifyjs dist/is-array-buffer.js -o dist/is-array-buffer.min.js -c -m --comments /^!/",
|
||||
"lint": "eslint src",
|
||||
"postbuild": "npm run test && npm run compress",
|
||||
"prebuild": "npm run lint",
|
||||
"test": "mocha"
|
||||
},
|
||||
"version": "1.0.0"
|
||||
}
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
const hasArrayBuffer = typeof ArrayBuffer === 'function';
|
||||
const toString = Object.prototype.toString;
|
||||
|
||||
/**
|
||||
* Check if the given value is an ArrayBuffer.
|
||||
* @param {*} value - The value to check.
|
||||
* @returns {boolean} Returns `true` if the given is an ArrayBuffer, else `false`.
|
||||
* @example
|
||||
* isArrayBuffer(new ArrayBuffer())
|
||||
* // => true
|
||||
* isArrayBuffer(new Array())
|
||||
* // => false
|
||||
*/
|
||||
export default function isArrayBuffer(value) {
|
||||
return hasArrayBuffer && (value instanceof ArrayBuffer || toString.call(value) === '[object ArrayBuffer]');
|
||||
}
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
'use strict';
|
||||
|
||||
var isStream = module.exports = function (stream) {
|
||||
return stream !== null && typeof stream === 'object' && typeof stream.pipe === 'function';
|
||||
};
|
||||
|
||||
isStream.writable = function (stream) {
|
||||
return isStream(stream) && stream.writable !== false && typeof stream._write === 'function' && typeof stream._writableState === 'object';
|
||||
};
|
||||
|
||||
isStream.readable = function (stream) {
|
||||
return isStream(stream) && stream.readable !== false && typeof stream._read === 'function' && typeof stream._readableState === 'object';
|
||||
};
|
||||
|
||||
isStream.duplex = function (stream) {
|
||||
return isStream.writable(stream) && isStream.readable(stream);
|
||||
};
|
||||
|
||||
isStream.transform = function (stream) {
|
||||
return isStream.duplex(stream) && typeof stream._transform === 'function' && typeof stream._transformState === 'object';
|
||||
};
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
+70
@@ -0,0 +1,70 @@
|
||||
{
|
||||
"_from": "is-stream@^1.1.0",
|
||||
"_id": "is-stream@1.1.0",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha1-EtSj3U5o4Lec6428hBc66A2RykQ=",
|
||||
"_location": "/is-stream",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"type": "range",
|
||||
"registry": true,
|
||||
"raw": "is-stream@^1.1.0",
|
||||
"name": "is-stream",
|
||||
"escapedName": "is-stream",
|
||||
"rawSpec": "^1.1.0",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "^1.1.0"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/@octokit/rest"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz",
|
||||
"_shasum": "12d4a3dd4e68e0b79ceb8dbc84173ae80d91ca44",
|
||||
"_spec": "is-stream@^1.1.0",
|
||||
"_where": "C:\\Users\\Luis\\source\\repos\\AAWebPlatform\\node_modules\\@octokit\\rest",
|
||||
"author": {
|
||||
"name": "Sindre Sorhus",
|
||||
"email": "sindresorhus@gmail.com",
|
||||
"url": "sindresorhus.com"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/sindresorhus/is-stream/issues"
|
||||
},
|
||||
"bundleDependencies": false,
|
||||
"deprecated": false,
|
||||
"description": "Check if something is a Node.js stream",
|
||||
"devDependencies": {
|
||||
"ava": "*",
|
||||
"tempfile": "^1.1.0",
|
||||
"xo": "*"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=0.10.0"
|
||||
},
|
||||
"files": [
|
||||
"index.js"
|
||||
],
|
||||
"homepage": "https://github.com/sindresorhus/is-stream#readme",
|
||||
"keywords": [
|
||||
"stream",
|
||||
"type",
|
||||
"streams",
|
||||
"writable",
|
||||
"readable",
|
||||
"duplex",
|
||||
"transform",
|
||||
"check",
|
||||
"detect",
|
||||
"is"
|
||||
],
|
||||
"license": "MIT",
|
||||
"name": "is-stream",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/sindresorhus/is-stream.git"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "xo && ava"
|
||||
},
|
||||
"version": "1.1.0"
|
||||
}
|
||||
+42
@@ -0,0 +1,42 @@
|
||||
# is-stream [](https://travis-ci.org/sindresorhus/is-stream)
|
||||
|
||||
> Check if something is a [Node.js stream](https://nodejs.org/api/stream.html)
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install --save is-stream
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const fs = require('fs');
|
||||
const isStream = require('is-stream');
|
||||
|
||||
isStream(fs.createReadStream('unicorn.png'));
|
||||
//=> true
|
||||
|
||||
isStream({});
|
||||
//=> false
|
||||
```
|
||||
|
||||
|
||||
## API
|
||||
|
||||
### isStream(stream)
|
||||
|
||||
#### isStream.writable(stream)
|
||||
|
||||
#### isStream.readable(stream)
|
||||
|
||||
#### isStream.duplex(stream)
|
||||
|
||||
#### isStream.transform(stream)
|
||||
|
||||
|
||||
## License
|
||||
|
||||
MIT © [Sindre Sorhus](https://sindresorhus.com)
|
||||
+47
@@ -0,0 +1,47 @@
|
||||
Copyright JS Foundation and other contributors <https://js.foundation/>
|
||||
|
||||
Based on Underscore.js, copyright Jeremy Ashkenas,
|
||||
DocumentCloud and Investigative Reporters & Editors <http://underscorejs.org/>
|
||||
|
||||
This software consists of voluntary contributions made by many
|
||||
individuals. For exact contribution history, see the revision history
|
||||
available at https://github.com/lodash/lodash
|
||||
|
||||
The following license applies to all parts of this software except as
|
||||
documented below:
|
||||
|
||||
====
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
====
|
||||
|
||||
Copyright and related rights for sample code are waived via CC0. Sample
|
||||
code is defined as all source code displayed within the prose of the
|
||||
documentation.
|
||||
|
||||
CC0: http://creativecommons.org/publicdomain/zero/1.0/
|
||||
|
||||
====
|
||||
|
||||
Files located in the node_modules and vendor directories are externally
|
||||
maintained libraries used by this software which have their own
|
||||
licenses; we recommend you read them, as their terms may differ from the
|
||||
terms above.
|
||||
+39
@@ -0,0 +1,39 @@
|
||||
# lodash v4.17.5
|
||||
|
||||
The [Lodash](https://lodash.com/) library exported as [Node.js](https://nodejs.org/) modules.
|
||||
|
||||
## Installation
|
||||
|
||||
Using npm:
|
||||
```shell
|
||||
$ npm i -g npm
|
||||
$ npm i --save lodash
|
||||
```
|
||||
|
||||
In Node.js:
|
||||
```js
|
||||
// Load the full build.
|
||||
var _ = require('lodash');
|
||||
// Load the core build.
|
||||
var _ = require('lodash/core');
|
||||
// Load the FP build for immutable auto-curried iteratee-first data-last methods.
|
||||
var fp = require('lodash/fp');
|
||||
|
||||
// Load method categories.
|
||||
var array = require('lodash/array');
|
||||
var object = require('lodash/fp/object');
|
||||
|
||||
// Cherry-pick methods for smaller browserify/rollup/webpack bundles.
|
||||
var at = require('lodash/at');
|
||||
var curryN = require('lodash/fp/curryN');
|
||||
```
|
||||
|
||||
See the [package source](https://github.com/lodash/lodash/tree/4.17.5-npm) for more details.
|
||||
|
||||
**Note:**<br>
|
||||
Install [n_](https://www.npmjs.com/package/n_) for Lodash use in the Node.js < 6 REPL.
|
||||
|
||||
## Support
|
||||
|
||||
Tested in Chrome 63-64, Firefox 57-58, IE 11, Edge 14, Safari 10-11, Node.js 4-9, & PhantomJS 2.1.1.<br>
|
||||
Automated [browser](https://saucelabs.com/u/lodash) & [CI](https://travis-ci.org/lodash/lodash/) test runs are available.
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
var getNative = require('./_getNative'),
|
||||
root = require('./_root');
|
||||
|
||||
/* Built-in method references that are verified to be native. */
|
||||
var DataView = getNative(root, 'DataView');
|
||||
|
||||
module.exports = DataView;
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
var hashClear = require('./_hashClear'),
|
||||
hashDelete = require('./_hashDelete'),
|
||||
hashGet = require('./_hashGet'),
|
||||
hashHas = require('./_hashHas'),
|
||||
hashSet = require('./_hashSet');
|
||||
|
||||
/**
|
||||
* Creates a hash object.
|
||||
*
|
||||
* @private
|
||||
* @constructor
|
||||
* @param {Array} [entries] The key-value pairs to cache.
|
||||
*/
|
||||
function Hash(entries) {
|
||||
var index = -1,
|
||||
length = entries == null ? 0 : entries.length;
|
||||
|
||||
this.clear();
|
||||
while (++index < length) {
|
||||
var entry = entries[index];
|
||||
this.set(entry[0], entry[1]);
|
||||
}
|
||||
}
|
||||
|
||||
// Add methods to `Hash`.
|
||||
Hash.prototype.clear = hashClear;
|
||||
Hash.prototype['delete'] = hashDelete;
|
||||
Hash.prototype.get = hashGet;
|
||||
Hash.prototype.has = hashHas;
|
||||
Hash.prototype.set = hashSet;
|
||||
|
||||
module.exports = Hash;
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
var baseCreate = require('./_baseCreate'),
|
||||
baseLodash = require('./_baseLodash');
|
||||
|
||||
/** Used as references for the maximum length and index of an array. */
|
||||
var MAX_ARRAY_LENGTH = 4294967295;
|
||||
|
||||
/**
|
||||
* Creates a lazy wrapper object which wraps `value` to enable lazy evaluation.
|
||||
*
|
||||
* @private
|
||||
* @constructor
|
||||
* @param {*} value The value to wrap.
|
||||
*/
|
||||
function LazyWrapper(value) {
|
||||
this.__wrapped__ = value;
|
||||
this.__actions__ = [];
|
||||
this.__dir__ = 1;
|
||||
this.__filtered__ = false;
|
||||
this.__iteratees__ = [];
|
||||
this.__takeCount__ = MAX_ARRAY_LENGTH;
|
||||
this.__views__ = [];
|
||||
}
|
||||
|
||||
// Ensure `LazyWrapper` is an instance of `baseLodash`.
|
||||
LazyWrapper.prototype = baseCreate(baseLodash.prototype);
|
||||
LazyWrapper.prototype.constructor = LazyWrapper;
|
||||
|
||||
module.exports = LazyWrapper;
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
var listCacheClear = require('./_listCacheClear'),
|
||||
listCacheDelete = require('./_listCacheDelete'),
|
||||
listCacheGet = require('./_listCacheGet'),
|
||||
listCacheHas = require('./_listCacheHas'),
|
||||
listCacheSet = require('./_listCacheSet');
|
||||
|
||||
/**
|
||||
* Creates an list cache object.
|
||||
*
|
||||
* @private
|
||||
* @constructor
|
||||
* @param {Array} [entries] The key-value pairs to cache.
|
||||
*/
|
||||
function ListCache(entries) {
|
||||
var index = -1,
|
||||
length = entries == null ? 0 : entries.length;
|
||||
|
||||
this.clear();
|
||||
while (++index < length) {
|
||||
var entry = entries[index];
|
||||
this.set(entry[0], entry[1]);
|
||||
}
|
||||
}
|
||||
|
||||
// Add methods to `ListCache`.
|
||||
ListCache.prototype.clear = listCacheClear;
|
||||
ListCache.prototype['delete'] = listCacheDelete;
|
||||
ListCache.prototype.get = listCacheGet;
|
||||
ListCache.prototype.has = listCacheHas;
|
||||
ListCache.prototype.set = listCacheSet;
|
||||
|
||||
module.exports = ListCache;
|
||||
+22
@@ -0,0 +1,22 @@
|
||||
var baseCreate = require('./_baseCreate'),
|
||||
baseLodash = require('./_baseLodash');
|
||||
|
||||
/**
|
||||
* The base constructor for creating `lodash` wrapper objects.
|
||||
*
|
||||
* @private
|
||||
* @param {*} value The value to wrap.
|
||||
* @param {boolean} [chainAll] Enable explicit method chain sequences.
|
||||
*/
|
||||
function LodashWrapper(value, chainAll) {
|
||||
this.__wrapped__ = value;
|
||||
this.__actions__ = [];
|
||||
this.__chain__ = !!chainAll;
|
||||
this.__index__ = 0;
|
||||
this.__values__ = undefined;
|
||||
}
|
||||
|
||||
LodashWrapper.prototype = baseCreate(baseLodash.prototype);
|
||||
LodashWrapper.prototype.constructor = LodashWrapper;
|
||||
|
||||
module.exports = LodashWrapper;
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
var getNative = require('./_getNative'),
|
||||
root = require('./_root');
|
||||
|
||||
/* Built-in method references that are verified to be native. */
|
||||
var Map = getNative(root, 'Map');
|
||||
|
||||
module.exports = Map;
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
var mapCacheClear = require('./_mapCacheClear'),
|
||||
mapCacheDelete = require('./_mapCacheDelete'),
|
||||
mapCacheGet = require('./_mapCacheGet'),
|
||||
mapCacheHas = require('./_mapCacheHas'),
|
||||
mapCacheSet = require('./_mapCacheSet');
|
||||
|
||||
/**
|
||||
* Creates a map cache object to store key-value pairs.
|
||||
*
|
||||
* @private
|
||||
* @constructor
|
||||
* @param {Array} [entries] The key-value pairs to cache.
|
||||
*/
|
||||
function MapCache(entries) {
|
||||
var index = -1,
|
||||
length = entries == null ? 0 : entries.length;
|
||||
|
||||
this.clear();
|
||||
while (++index < length) {
|
||||
var entry = entries[index];
|
||||
this.set(entry[0], entry[1]);
|
||||
}
|
||||
}
|
||||
|
||||
// Add methods to `MapCache`.
|
||||
MapCache.prototype.clear = mapCacheClear;
|
||||
MapCache.prototype['delete'] = mapCacheDelete;
|
||||
MapCache.prototype.get = mapCacheGet;
|
||||
MapCache.prototype.has = mapCacheHas;
|
||||
MapCache.prototype.set = mapCacheSet;
|
||||
|
||||
module.exports = MapCache;
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
var getNative = require('./_getNative'),
|
||||
root = require('./_root');
|
||||
|
||||
/* Built-in method references that are verified to be native. */
|
||||
var Promise = getNative(root, 'Promise');
|
||||
|
||||
module.exports = Promise;
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
var getNative = require('./_getNative'),
|
||||
root = require('./_root');
|
||||
|
||||
/* Built-in method references that are verified to be native. */
|
||||
var Set = getNative(root, 'Set');
|
||||
|
||||
module.exports = Set;
|
||||
+27
@@ -0,0 +1,27 @@
|
||||
var MapCache = require('./_MapCache'),
|
||||
setCacheAdd = require('./_setCacheAdd'),
|
||||
setCacheHas = require('./_setCacheHas');
|
||||
|
||||
/**
|
||||
*
|
||||
* Creates an array cache object to store unique values.
|
||||
*
|
||||
* @private
|
||||
* @constructor
|
||||
* @param {Array} [values] The values to cache.
|
||||
*/
|
||||
function SetCache(values) {
|
||||
var index = -1,
|
||||
length = values == null ? 0 : values.length;
|
||||
|
||||
this.__data__ = new MapCache;
|
||||
while (++index < length) {
|
||||
this.add(values[index]);
|
||||
}
|
||||
}
|
||||
|
||||
// Add methods to `SetCache`.
|
||||
SetCache.prototype.add = SetCache.prototype.push = setCacheAdd;
|
||||
SetCache.prototype.has = setCacheHas;
|
||||
|
||||
module.exports = SetCache;
|
||||
+27
@@ -0,0 +1,27 @@
|
||||
var ListCache = require('./_ListCache'),
|
||||
stackClear = require('./_stackClear'),
|
||||
stackDelete = require('./_stackDelete'),
|
||||
stackGet = require('./_stackGet'),
|
||||
stackHas = require('./_stackHas'),
|
||||
stackSet = require('./_stackSet');
|
||||
|
||||
/**
|
||||
* Creates a stack cache object to store key-value pairs.
|
||||
*
|
||||
* @private
|
||||
* @constructor
|
||||
* @param {Array} [entries] The key-value pairs to cache.
|
||||
*/
|
||||
function Stack(entries) {
|
||||
var data = this.__data__ = new ListCache(entries);
|
||||
this.size = data.size;
|
||||
}
|
||||
|
||||
// Add methods to `Stack`.
|
||||
Stack.prototype.clear = stackClear;
|
||||
Stack.prototype['delete'] = stackDelete;
|
||||
Stack.prototype.get = stackGet;
|
||||
Stack.prototype.has = stackHas;
|
||||
Stack.prototype.set = stackSet;
|
||||
|
||||
module.exports = Stack;
|
||||
+6
@@ -0,0 +1,6 @@
|
||||
var root = require('./_root');
|
||||
|
||||
/** Built-in value references. */
|
||||
var Symbol = root.Symbol;
|
||||
|
||||
module.exports = Symbol;
|
||||
+6
@@ -0,0 +1,6 @@
|
||||
var root = require('./_root');
|
||||
|
||||
/** Built-in value references. */
|
||||
var Uint8Array = root.Uint8Array;
|
||||
|
||||
module.exports = Uint8Array;
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
var getNative = require('./_getNative'),
|
||||
root = require('./_root');
|
||||
|
||||
/* Built-in method references that are verified to be native. */
|
||||
var WeakMap = getNative(root, 'WeakMap');
|
||||
|
||||
module.exports = WeakMap;
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
/**
|
||||
* A faster alternative to `Function#apply`, this function invokes `func`
|
||||
* with the `this` binding of `thisArg` and the arguments of `args`.
|
||||
*
|
||||
* @private
|
||||
* @param {Function} func The function to invoke.
|
||||
* @param {*} thisArg The `this` binding of `func`.
|
||||
* @param {Array} args The arguments to invoke `func` with.
|
||||
* @returns {*} Returns the result of `func`.
|
||||
*/
|
||||
function apply(func, thisArg, args) {
|
||||
switch (args.length) {
|
||||
case 0: return func.call(thisArg);
|
||||
case 1: return func.call(thisArg, args[0]);
|
||||
case 2: return func.call(thisArg, args[0], args[1]);
|
||||
case 3: return func.call(thisArg, args[0], args[1], args[2]);
|
||||
}
|
||||
return func.apply(thisArg, args);
|
||||
}
|
||||
|
||||
module.exports = apply;
|
||||
+22
@@ -0,0 +1,22 @@
|
||||
/**
|
||||
* A specialized version of `baseAggregator` for arrays.
|
||||
*
|
||||
* @private
|
||||
* @param {Array} [array] The array to iterate over.
|
||||
* @param {Function} setter The function to set `accumulator` values.
|
||||
* @param {Function} iteratee The iteratee to transform keys.
|
||||
* @param {Object} accumulator The initial aggregated object.
|
||||
* @returns {Function} Returns `accumulator`.
|
||||
*/
|
||||
function arrayAggregator(array, setter, iteratee, accumulator) {
|
||||
var index = -1,
|
||||
length = array == null ? 0 : array.length;
|
||||
|
||||
while (++index < length) {
|
||||
var value = array[index];
|
||||
setter(accumulator, value, iteratee(value), array);
|
||||
}
|
||||
return accumulator;
|
||||
}
|
||||
|
||||
module.exports = arrayAggregator;
|
||||
+22
@@ -0,0 +1,22 @@
|
||||
/**
|
||||
* A specialized version of `_.forEach` for arrays without support for
|
||||
* iteratee shorthands.
|
||||
*
|
||||
* @private
|
||||
* @param {Array} [array] The array to iterate over.
|
||||
* @param {Function} iteratee The function invoked per iteration.
|
||||
* @returns {Array} Returns `array`.
|
||||
*/
|
||||
function arrayEach(array, iteratee) {
|
||||
var index = -1,
|
||||
length = array == null ? 0 : array.length;
|
||||
|
||||
while (++index < length) {
|
||||
if (iteratee(array[index], index, array) === false) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
return array;
|
||||
}
|
||||
|
||||
module.exports = arrayEach;
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
/**
|
||||
* A specialized version of `_.forEachRight` for arrays without support for
|
||||
* iteratee shorthands.
|
||||
*
|
||||
* @private
|
||||
* @param {Array} [array] The array to iterate over.
|
||||
* @param {Function} iteratee The function invoked per iteration.
|
||||
* @returns {Array} Returns `array`.
|
||||
*/
|
||||
function arrayEachRight(array, iteratee) {
|
||||
var length = array == null ? 0 : array.length;
|
||||
|
||||
while (length--) {
|
||||
if (iteratee(array[length], length, array) === false) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
return array;
|
||||
}
|
||||
|
||||
module.exports = arrayEachRight;
|
||||
+23
@@ -0,0 +1,23 @@
|
||||
/**
|
||||
* A specialized version of `_.every` for arrays without support for
|
||||
* iteratee shorthands.
|
||||
*
|
||||
* @private
|
||||
* @param {Array} [array] The array to iterate over.
|
||||
* @param {Function} predicate The function invoked per iteration.
|
||||
* @returns {boolean} Returns `true` if all elements pass the predicate check,
|
||||
* else `false`.
|
||||
*/
|
||||
function arrayEvery(array, predicate) {
|
||||
var index = -1,
|
||||
length = array == null ? 0 : array.length;
|
||||
|
||||
while (++index < length) {
|
||||
if (!predicate(array[index], index, array)) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
module.exports = arrayEvery;
|
||||
+25
@@ -0,0 +1,25 @@
|
||||
/**
|
||||
* A specialized version of `_.filter` for arrays without support for
|
||||
* iteratee shorthands.
|
||||
*
|
||||
* @private
|
||||
* @param {Array} [array] The array to iterate over.
|
||||
* @param {Function} predicate The function invoked per iteration.
|
||||
* @returns {Array} Returns the new filtered array.
|
||||
*/
|
||||
function arrayFilter(array, predicate) {
|
||||
var index = -1,
|
||||
length = array == null ? 0 : array.length,
|
||||
resIndex = 0,
|
||||
result = [];
|
||||
|
||||
while (++index < length) {
|
||||
var value = array[index];
|
||||
if (predicate(value, index, array)) {
|
||||
result[resIndex++] = value;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
module.exports = arrayFilter;
|
||||
+17
@@ -0,0 +1,17 @@
|
||||
var baseIndexOf = require('./_baseIndexOf');
|
||||
|
||||
/**
|
||||
* A specialized version of `_.includes` for arrays without support for
|
||||
* specifying an index to search from.
|
||||
*
|
||||
* @private
|
||||
* @param {Array} [array] The array to inspect.
|
||||
* @param {*} target The value to search for.
|
||||
* @returns {boolean} Returns `true` if `target` is found, else `false`.
|
||||
*/
|
||||
function arrayIncludes(array, value) {
|
||||
var length = array == null ? 0 : array.length;
|
||||
return !!length && baseIndexOf(array, value, 0) > -1;
|
||||
}
|
||||
|
||||
module.exports = arrayIncludes;
|
||||
+22
@@ -0,0 +1,22 @@
|
||||
/**
|
||||
* This function is like `arrayIncludes` except that it accepts a comparator.
|
||||
*
|
||||
* @private
|
||||
* @param {Array} [array] The array to inspect.
|
||||
* @param {*} target The value to search for.
|
||||
* @param {Function} comparator The comparator invoked per element.
|
||||
* @returns {boolean} Returns `true` if `target` is found, else `false`.
|
||||
*/
|
||||
function arrayIncludesWith(array, value, comparator) {
|
||||
var index = -1,
|
||||
length = array == null ? 0 : array.length;
|
||||
|
||||
while (++index < length) {
|
||||
if (comparator(value, array[index])) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
module.exports = arrayIncludesWith;
|
||||
+49
@@ -0,0 +1,49 @@
|
||||
var baseTimes = require('./_baseTimes'),
|
||||
isArguments = require('./isArguments'),
|
||||
isArray = require('./isArray'),
|
||||
isBuffer = require('./isBuffer'),
|
||||
isIndex = require('./_isIndex'),
|
||||
isTypedArray = require('./isTypedArray');
|
||||
|
||||
/** Used for built-in method references. */
|
||||
var objectProto = Object.prototype;
|
||||
|
||||
/** Used to check objects for own properties. */
|
||||
var hasOwnProperty = objectProto.hasOwnProperty;
|
||||
|
||||
/**
|
||||
* Creates an array of the enumerable property names of the array-like `value`.
|
||||
*
|
||||
* @private
|
||||
* @param {*} value The value to query.
|
||||
* @param {boolean} inherited Specify returning inherited property names.
|
||||
* @returns {Array} Returns the array of property names.
|
||||
*/
|
||||
function arrayLikeKeys(value, inherited) {
|
||||
var isArr = isArray(value),
|
||||
isArg = !isArr && isArguments(value),
|
||||
isBuff = !isArr && !isArg && isBuffer(value),
|
||||
isType = !isArr && !isArg && !isBuff && isTypedArray(value),
|
||||
skipIndexes = isArr || isArg || isBuff || isType,
|
||||
result = skipIndexes ? baseTimes(value.length, String) : [],
|
||||
length = result.length;
|
||||
|
||||
for (var key in value) {
|
||||
if ((inherited || hasOwnProperty.call(value, key)) &&
|
||||
!(skipIndexes && (
|
||||
// Safari 9 has enumerable `arguments.length` in strict mode.
|
||||
key == 'length' ||
|
||||
// Node.js 0.10 has enumerable non-index properties on buffers.
|
||||
(isBuff && (key == 'offset' || key == 'parent')) ||
|
||||
// PhantomJS 2 has enumerable non-index properties on typed arrays.
|
||||
(isType && (key == 'buffer' || key == 'byteLength' || key == 'byteOffset')) ||
|
||||
// Skip index properties.
|
||||
isIndex(key, length)
|
||||
))) {
|
||||
result.push(key);
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
module.exports = arrayLikeKeys;
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
/**
|
||||
* A specialized version of `_.map` for arrays without support for iteratee
|
||||
* shorthands.
|
||||
*
|
||||
* @private
|
||||
* @param {Array} [array] The array to iterate over.
|
||||
* @param {Function} iteratee The function invoked per iteration.
|
||||
* @returns {Array} Returns the new mapped array.
|
||||
*/
|
||||
function arrayMap(array, iteratee) {
|
||||
var index = -1,
|
||||
length = array == null ? 0 : array.length,
|
||||
result = Array(length);
|
||||
|
||||
while (++index < length) {
|
||||
result[index] = iteratee(array[index], index, array);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
module.exports = arrayMap;
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
/**
|
||||
* Appends the elements of `values` to `array`.
|
||||
*
|
||||
* @private
|
||||
* @param {Array} array The array to modify.
|
||||
* @param {Array} values The values to append.
|
||||
* @returns {Array} Returns `array`.
|
||||
*/
|
||||
function arrayPush(array, values) {
|
||||
var index = -1,
|
||||
length = values.length,
|
||||
offset = array.length;
|
||||
|
||||
while (++index < length) {
|
||||
array[offset + index] = values[index];
|
||||
}
|
||||
return array;
|
||||
}
|
||||
|
||||
module.exports = arrayPush;
|
||||
Loaded 100 of 1145 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user