14692 lines
583 KiB
Plaintext
14692 lines
583 KiB
Plaintext
The following NPM packages may be included in this product:
|
||
|
||
- @dabh/diagnostics@2.0.2
|
||
- colorspace@1.1.2
|
||
- enabled@2.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 Arnout Kazemier, Martijn Swaagman, the 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @firebase/app-types@0.6.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# @firebase/app-types
|
||
|
||
**This package is not intended for direct usage, and should only be used via the officially supported [firebase](https://www.npmjs.com/package/firebase) package.**
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @firebase/auth-interop-types@0.1.5
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# @firebase/auth-interop-types
|
||
|
||
**This package is not intended for direct usage, and should only be used via the officially supported [firebase](https://www.npmjs.com/package/firebase) package.**
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @firebase/component@0.1.21
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# @firebase/component
|
||
|
||
_NOTE: This is specifically tailored for Firebase JS SDK usage, if you are not a
|
||
member of the Firebase team, please avoid using this package_
|
||
|
||
## Usage
|
||
|
||
**ES Modules**
|
||
|
||
```javascript
|
||
import { Component } from '@firebase/component';
|
||
```
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @firebase/database-types@0.6.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# @firebase/database-types
|
||
|
||
**This package is not intended for direct usage, and should only be used via the officially supported [firebase](https://www.npmjs.com/package/firebase) package.**
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @firebase/database@0.8.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# @firebase/database
|
||
|
||
This is the Firebase Realtime Database component of the Firebase JS SDK.
|
||
|
||
**This package is not intended for direct usage, and should only be used via the officially supported [firebase](https://www.npmjs.com/package/firebase) package.**
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @firebase/logger@0.2.6
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# @firebase/logger
|
||
|
||
This package serves as the base of all logging in the JS SDK. Any logging that
|
||
is intended to be visible to Firebase end developers should go through this
|
||
module.
|
||
|
||
## Basic Usage
|
||
|
||
Firebase components should import the `Logger` class and instantiate a new
|
||
instance by passing a component name (e.g. `@firebase/<COMPONENT>`) to the
|
||
constructor.
|
||
|
||
_e.g._
|
||
|
||
```typescript
|
||
import { Logger } from '@firebase/logger';
|
||
|
||
const logClient = new Logger(`@firebase/<COMPONENT>`);
|
||
```
|
||
|
||
Each `Logger` instance supports 5 log functions each to be used in a specific
|
||
instance:
|
||
|
||
- `debug`: Internal logs; use this to allow developers to send us their debug
|
||
logs for us to be able to diagnose an issue.
|
||
- `log`: Use to inform your user about things they may need to know.
|
||
- `info`: Use if you have to inform the user about something that they need to
|
||
take a concrete action on. Once they take that action, the log should go away.
|
||
- `warn`: Use when a product feature may stop functioning correctly; unexpected
|
||
scenario.
|
||
- `error`: Only use when user App would stop functioning correctly - super rare!
|
||
|
||
## Log Format
|
||
|
||
Each log will be formatted in the following manner:
|
||
|
||
```typescript
|
||
`[${new Date()}] ${COMPONENT_NAME}: ${...args}`
|
||
```
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @firebase/util@0.3.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# @firebase/util
|
||
|
||
_NOTE: This is specifically tailored for Firebase JS SDK usage, if you are not a
|
||
member of the Firebase team, please avoid using this package_
|
||
|
||
This is a wrapper of some Webchannel Features for the Firebase JS SDK.
|
||
|
||
## Usage
|
||
|
||
**ES Modules**
|
||
|
||
```javascript
|
||
import { Deferred } from '@firebase/util';
|
||
|
||
// Do stuff with Deferred or any of the other Utils you import
|
||
```
|
||
|
||
**CommonJS Modules**
|
||
|
||
```javascript
|
||
const utils = require('@firebase/util');
|
||
|
||
// Do stuff with any of the re-exported `utils`
|
||
```
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @google-cloud/common@3.6.0
|
||
- @google-cloud/firestore@4.9.8
|
||
- @google-cloud/paginator@3.0.5
|
||
- @google-cloud/projectify@2.0.1
|
||
- @google-cloud/promisify@2.0.3
|
||
- @google-cloud/storage@5.8.3
|
||
- gaxios@4.2.0
|
||
- gcp-metadata@4.2.1
|
||
- google-auth-library@6.1.6
|
||
- google-auth-library@7.0.3
|
||
- google-gax@2.11.2
|
||
- teeny-request@7.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
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 [yyyy] [name of copyright owner]
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @grpc/grpc-js@1.2.12
|
||
- @grpc/proto-loader@0.5.6
|
||
- fast-text-encoding@1.0.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
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 {yyyy} {name of copyright owner}
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @jonkemp/package-utils@1.0.7
|
||
- css-rules@1.0.9
|
||
- extract-css@2.0.0
|
||
- flat-util@1.1.7
|
||
- href-content@2.0.0
|
||
- inline-css@3.0.0
|
||
- list-stylesheets@1.2.9
|
||
- mediaquery-text@1.1.5
|
||
- pick-util@1.1.3
|
||
- remote-content@2.0.0
|
||
- style-data@1.4.7
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) Jonathan Kemp <kempdogg@gmail.com> (jonkemp.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @oozcitak/dom@1.15.8
|
||
- @oozcitak/infra@1.0.8
|
||
- @oozcitak/url@1.0.4
|
||
- @oozcitak/util@8.3.8
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2019 Ozgur Ozcitak
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @protobufjs/aspromise@1.1.2
|
||
- @protobufjs/base64@1.1.2
|
||
- @protobufjs/codegen@2.0.4
|
||
- @protobufjs/eventemitter@1.1.0
|
||
- @protobufjs/fetch@1.1.0
|
||
- @protobufjs/float@1.0.2
|
||
- @protobufjs/inquire@1.1.0
|
||
- @protobufjs/path@1.1.2
|
||
- @protobufjs/pool@1.1.0
|
||
- @protobufjs/utf8@1.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2016, Daniel Wirtz All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are
|
||
met:
|
||
|
||
* Redistributions of source code must retain the above copyright
|
||
notice, this list of conditions and the following disclaimer.
|
||
* Redistributions in binary form must reproduce the above copyright
|
||
notice, this list of conditions and the following disclaimer in the
|
||
documentation and/or other materials provided with the distribution.
|
||
* Neither the name of its author, nor the names of its contributors
|
||
may be used to endorse or promote products derived from this software
|
||
without specific prior written permission.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @types/concat-stream@1.6.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# Installation
|
||
> `npm install --save @types/concat-stream`
|
||
|
||
# Summary
|
||
This package contains type definitions for concat-stream (https://github.com/maxogden/concat-stream).
|
||
|
||
# Details
|
||
Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/master/concat-stream
|
||
|
||
Additional Details
|
||
* Last updated: Mon, 09 Jan 2017 15:21:42 GMT
|
||
* Library Dependencies: node
|
||
* Module Dependencies: stream
|
||
* Global values: none
|
||
|
||
# Credits
|
||
These definitions were written by Joey Marianer <https://github.com/jmarianer>.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @types/form-data@0.0.33
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# Installation
|
||
> `npm install --save @types/form-data`
|
||
|
||
# Summary
|
||
This package contains type definitions for form-data (https://github.com/felixge/node-form-data).
|
||
|
||
# Details
|
||
Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/types-2.0/form-data
|
||
|
||
Additional Details
|
||
* Last updated: Tue, 22 Nov 2016 23:38:10 GMT
|
||
* File structure: ProperModule
|
||
* Library Dependencies: node
|
||
* Module Dependencies: stream
|
||
* Global values: FormData
|
||
|
||
# Credits
|
||
These definitions were written by Carlos Ballesteros Velasco <https://github.com/soywiz>, Leon Yu <https://github.com/leonyu>.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @types/long@4.0.1
|
||
- @types/methods@1.1.1
|
||
- @types/tough-cookie@2.3.7
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||
|
||
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
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- @types/node@10.17.56
|
||
- @types/node@13.13.48
|
||
- @types/node@14.14.37
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) Microsoft Corporation.
|
||
|
||
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
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- abort-controller@3.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2017 Toru Nagashima
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- accepts@1.3.7
|
||
- mime-types@2.1.29
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
|
||
Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- agent-base@4.3.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
agent-base
|
||
==========
|
||
### Turn a function into an [`http.Agent`][http.Agent] instance
|
||
[](https://travis-ci.org/TooTallNate/node-agent-base)
|
||
|
||
This module provides an `http.Agent` generator. That is, you pass it an async
|
||
callback function, and it returns a new `http.Agent` instance that will invoke the
|
||
given callback function when sending outbound HTTP requests.
|
||
|
||
#### Some subclasses:
|
||
|
||
Here's some more interesting uses of `agent-base`.
|
||
Send a pull request to list yours!
|
||
|
||
* [`http-proxy-agent`][http-proxy-agent]: An HTTP(s) proxy `http.Agent` implementation for HTTP endpoints
|
||
* [`https-proxy-agent`][https-proxy-agent]: An HTTP(s) proxy `http.Agent` implementation for HTTPS endpoints
|
||
* [`pac-proxy-agent`][pac-proxy-agent]: A PAC file proxy `http.Agent` implementation for HTTP and HTTPS
|
||
* [`socks-proxy-agent`][socks-proxy-agent]: A SOCKS (v4a) proxy `http.Agent` implementation for HTTP and HTTPS
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install agent-base
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
Here's a minimal example that creates a new `net.Socket` connection to the server
|
||
for every HTTP request (i.e. the equivalent of `agent: false` option):
|
||
|
||
```js
|
||
var net = require('net');
|
||
var tls = require('tls');
|
||
var url = require('url');
|
||
var http = require('http');
|
||
var agent = require('agent-base');
|
||
|
||
var endpoint = 'http://nodejs.org/api/';
|
||
var parsed = url.parse(endpoint);
|
||
|
||
// This is the important part!
|
||
parsed.agent = agent(function (req, opts) {
|
||
var socket;
|
||
// `secureEndpoint` is true when using the https module
|
||
if (opts.secureEndpoint) {
|
||
socket = tls.connect(opts);
|
||
} else {
|
||
socket = net.connect(opts);
|
||
}
|
||
return socket;
|
||
});
|
||
|
||
// Everything else works just like normal...
|
||
http.get(parsed, function (res) {
|
||
console.log('"response" event!', res.headers);
|
||
res.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
Returning a Promise or using an `async` function is also supported:
|
||
|
||
```js
|
||
agent(async function (req, opts) {
|
||
await sleep(1000);
|
||
// etc…
|
||
});
|
||
```
|
||
|
||
Return another `http.Agent` instance to "pass through" the responsibility
|
||
for that HTTP request to that agent:
|
||
|
||
```js
|
||
agent(function (req, opts) {
|
||
return opts.secureEndpoint ? https.globalAgent : http.globalAgent;
|
||
});
|
||
```
|
||
|
||
|
||
API
|
||
---
|
||
|
||
## Agent(Function callback[, Object options]) → [http.Agent][]
|
||
|
||
Creates a base `http.Agent` that will execute the callback function `callback`
|
||
for every HTTP request that it is used as the `agent` for. The callback function
|
||
is responsible for creating a `stream.Duplex` instance of some kind that will be
|
||
used as the underlying socket in the HTTP request.
|
||
|
||
The `options` object accepts the following properties:
|
||
|
||
* `timeout` - Number - Timeout for the `callback()` function in milliseconds. Defaults to Infinity (optional).
|
||
|
||
The callback function should have the following signature:
|
||
|
||
### callback(http.ClientRequest req, Object options, Function cb) → undefined
|
||
|
||
The ClientRequest `req` can be accessed to read request headers and
|
||
and the path, etc. The `options` object contains the options passed
|
||
to the `http.request()`/`https.request()` function call, and is formatted
|
||
to be directly passed to `net.connect()`/`tls.connect()`, or however
|
||
else you want a Socket to be created. Pass the created socket to
|
||
the callback function `cb` once created, and the HTTP request will
|
||
continue to proceed.
|
||
|
||
If the `https` module is used to invoke the HTTP request, then the
|
||
`secureEndpoint` property on `options` _will be set to `true`_.
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
[http-proxy-agent]: https://github.com/TooTallNate/node-http-proxy-agent
|
||
[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent
|
||
[pac-proxy-agent]: https://github.com/TooTallNate/node-pac-proxy-agent
|
||
[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent
|
||
[http.Agent]: https://nodejs.org/api/http.html#http_class_http_agent
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- agent-base@6.0.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
agent-base
|
||
==========
|
||
### Turn a function into an [`http.Agent`][http.Agent] instance
|
||
[](https://github.com/TooTallNate/node-agent-base/actions?workflow=Node+CI)
|
||
|
||
This module provides an `http.Agent` generator. That is, you pass it an async
|
||
callback function, and it returns a new `http.Agent` instance that will invoke the
|
||
given callback function when sending outbound HTTP requests.
|
||
|
||
#### Some subclasses:
|
||
|
||
Here's some more interesting uses of `agent-base`.
|
||
Send a pull request to list yours!
|
||
|
||
* [`http-proxy-agent`][http-proxy-agent]: An HTTP(s) proxy `http.Agent` implementation for HTTP endpoints
|
||
* [`https-proxy-agent`][https-proxy-agent]: An HTTP(s) proxy `http.Agent` implementation for HTTPS endpoints
|
||
* [`pac-proxy-agent`][pac-proxy-agent]: A PAC file proxy `http.Agent` implementation for HTTP and HTTPS
|
||
* [`socks-proxy-agent`][socks-proxy-agent]: A SOCKS proxy `http.Agent` implementation for HTTP and HTTPS
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install agent-base
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
Here's a minimal example that creates a new `net.Socket` connection to the server
|
||
for every HTTP request (i.e. the equivalent of `agent: false` option):
|
||
|
||
```js
|
||
var net = require('net');
|
||
var tls = require('tls');
|
||
var url = require('url');
|
||
var http = require('http');
|
||
var agent = require('agent-base');
|
||
|
||
var endpoint = 'http://nodejs.org/api/';
|
||
var parsed = url.parse(endpoint);
|
||
|
||
// This is the important part!
|
||
parsed.agent = agent(function (req, opts) {
|
||
var socket;
|
||
// `secureEndpoint` is true when using the https module
|
||
if (opts.secureEndpoint) {
|
||
socket = tls.connect(opts);
|
||
} else {
|
||
socket = net.connect(opts);
|
||
}
|
||
return socket;
|
||
});
|
||
|
||
// Everything else works just like normal...
|
||
http.get(parsed, function (res) {
|
||
console.log('"response" event!', res.headers);
|
||
res.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
Returning a Promise or using an `async` function is also supported:
|
||
|
||
```js
|
||
agent(async function (req, opts) {
|
||
await sleep(1000);
|
||
// etc…
|
||
});
|
||
```
|
||
|
||
Return another `http.Agent` instance to "pass through" the responsibility
|
||
for that HTTP request to that agent:
|
||
|
||
```js
|
||
agent(function (req, opts) {
|
||
return opts.secureEndpoint ? https.globalAgent : http.globalAgent;
|
||
});
|
||
```
|
||
|
||
|
||
API
|
||
---
|
||
|
||
## Agent(Function callback[, Object options]) → [http.Agent][]
|
||
|
||
Creates a base `http.Agent` that will execute the callback function `callback`
|
||
for every HTTP request that it is used as the `agent` for. The callback function
|
||
is responsible for creating a `stream.Duplex` instance of some kind that will be
|
||
used as the underlying socket in the HTTP request.
|
||
|
||
The `options` object accepts the following properties:
|
||
|
||
* `timeout` - Number - Timeout for the `callback()` function in milliseconds. Defaults to Infinity (optional).
|
||
|
||
The callback function should have the following signature:
|
||
|
||
### callback(http.ClientRequest req, Object options, Function cb) → undefined
|
||
|
||
The ClientRequest `req` can be accessed to read request headers and
|
||
and the path, etc. The `options` object contains the options passed
|
||
to the `http.request()`/`https.request()` function call, and is formatted
|
||
to be directly passed to `net.connect()`/`tls.connect()`, or however
|
||
else you want a Socket to be created. Pass the created socket to
|
||
the callback function `cb` once created, and the HTTP request will
|
||
continue to proceed.
|
||
|
||
If the `https` module is used to invoke the HTTP request, then the
|
||
`secureEndpoint` property on `options` _will be set to `true`_.
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
[http-proxy-agent]: https://github.com/TooTallNate/node-http-proxy-agent
|
||
[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent
|
||
[pac-proxy-agent]: https://github.com/TooTallNate/node-pac-proxy-agent
|
||
[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent
|
||
[http.Agent]: https://nodejs.org/api/http.html#http_class_http_agent
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- argparse@1.0.10
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (C) 2012 by Vitaly Puzrin
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- array-flatten@1.1.1
|
||
- path-to-regexp@0.1.7
|
||
- popsicle@10.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014 Blake Embrey (hello@blakeembrey.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- arrify@2.0.1
|
||
- crypto-random-string@2.0.0
|
||
- dot-prop@5.3.0
|
||
- is-obj@2.0.0
|
||
- is-stream@2.0.0
|
||
- make-dir@3.1.0
|
||
- mimic-fn@2.1.0
|
||
- split-on-first@1.1.0
|
||
- unique-string@2.0.0
|
||
- xdg-basedir@4.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- asap@2.0.6
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2009–2014 Contributors. All rights reserved.
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- ast-types@0.13.4
|
||
- ast-types@0.14.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2013 Ben Newman <bn@cs.stanford.edu>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- async-retry@1.3.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2017 ZEIT, Inc.
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- async@3.2.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2010-2018 Caolan McMahon
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- asynckit@0.4.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2016 Alex Indigo
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- atob@2.1.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
At your option you may choose either of the following licenses:
|
||
|
||
* The MIT License (MIT)
|
||
* The Apache License 2.0 (Apache-2.0)
|
||
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 AJ ONeal
|
||
|
||
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.
|
||
|
||
|
||
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 2015 AJ ONeal
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- aws-sdk@2.893.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
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 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- axios@0.21.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2014-present Matt Zabriskie
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- base64-js@1.5.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014 Jameson Little
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- batch@0.6.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- bignumber.js@4.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT Licence.
|
||
|
||
Copyright (c) 2017 Michael Mclaughlin
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- bignumber.js@9.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
=====================
|
||
|
||
Copyright © `<2020>` `Michael Mclaughlin`
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- bluebird@3.7.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2013-2018 Petka Antonov
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- body-parser@1.19.0
|
||
- compression@1.7.4
|
||
- type-is@1.6.18
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
|
||
Copyright (c) 2014-2015 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- bodyshop-server@0.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Yarn Dependency Management:
|
||
To force upgrades for some packages:
|
||
yarn upgrade-interactive --latest
|
||
|
||
To Start Hasura CLI:
|
||
npx hasura console
|
||
|
||
Migrating to Staging:
|
||
npx hasura migrate apply --endpoint https://db.imex.online/ --admin-secret 'Production-ImEXOnline!@#'
|
||
npx hasura migrate apply --endpoint https://db.test.bodyshop.app/ --admin-secret 'Test-ImEXOnlineBySnaptSoftware!'
|
||
|
||
NGROK TEsting:
|
||
./ngrok.exe http http://localhost:5000 -host-header="localhost:5000"
|
||
|
||
Finding deadfiles - run from client directory
|
||
npx deadfile ./src/index.js --exclude build templates
|
||
|
||
#Crushing all hasura migrations by creating a new initialization from the server.
|
||
hasura migrate create "Init" --from-server --endpoint https://db.imex.online/ --admin-secret 'Production-ImEXOnline!@#'
|
||
hasura migrate apply --version "1620771761757" --skip-execution --endpoint https://db.imex.online/ --admin-secret 'Production-ImEXOnline!@#'
|
||
hasura migrate status --endpoint https://db.imex.online/ --admin-secret 'Production-ImEXOnline!@#'
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- boolbase@1.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
#boolbase
|
||
This very simple module provides two basic functions, one that always returns true (`trueFunc`) and one that always returns false (`falseFunc`).
|
||
|
||
###WTF?
|
||
|
||
By having only a single instance of these functions around, it's possible to do some nice optimizations. Eg. [`CSSselect`](https://github.com/fb55/CSSselect) uses these functions to determine whether a selector won't match any elements. If that's the case, the DOM doesn't even have to be touched.
|
||
|
||
###And why is this a separate module?
|
||
|
||
I'm trying to modularize `CSSselect` and most modules depend on these functions. IMHO, having a separate module is the easiest solution to this problem.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- buffer-equal-constant-time@1.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2013, GoInstant Inc., a salesforce.com company
|
||
All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||
|
||
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||
|
||
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||
|
||
* Neither the name of salesforce.com, nor GoInstant, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- buffer-from@1.1.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2016, 2018 Linus Unnebäck
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- buffer@4.9.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) Feross Aboukhadijeh, and other 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- bytes@3.0.0
|
||
- bytes@3.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2012-2014 TJ Holowaychuk <tj@vision-media.ca>
|
||
Copyright (c) 2015 Jed Watson <jed.watson@me.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- call-bind@1.0.2
|
||
- get-intrinsic@1.1.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2020 Jordan Harband
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- cheerio@0.22.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
<h1 align="center">cheerio</h1>
|
||
|
||
<h5 align="center">Fast, flexible & lean implementation of core jQuery designed specifically for the server.</h5>
|
||
|
||
<div align="center">
|
||
<a href="http://travis-ci.org/cheeriojs/cheerio">
|
||
<img src="https://secure.travis-ci.org/cheeriojs/cheerio.svg?branch=master" alt="Travis CI" />
|
||
</a>
|
||
<a href="https://coveralls.io/r/cheeriojs/cheerio">
|
||
<img src="http://img.shields.io/coveralls/cheeriojs/cheerio.svg?branch=master&style=flat" alt="Coverage" />
|
||
</a>
|
||
<a href="https://gitter.im/cheeriojs/cheerio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">
|
||
<img src="https://badges.gitter.im/Join%20Chat.svg" alt="Join the chat at https://gitter.im/cheeriojs/cheerio" />
|
||
</a>
|
||
<a href="#backers">
|
||
<img src="https://opencollective.com/cheerio/backers/badge.svg" alt="OpenCollective backers"/>
|
||
</a>
|
||
<a href="#sponsors">
|
||
<img src="https://opencollective.com/cheerio/sponsors/badge.svg" alt="OpenCollective sponsors"/>
|
||
</a>
|
||
</div>
|
||
|
||
<br />
|
||
|
||
```js
|
||
let cheerio = require('cheerio')
|
||
let $ = cheerio.load('<h2 class="title">Hello world</h2>')
|
||
|
||
$('h2.title').text('Hello there!')
|
||
$('h2').addClass('welcome')
|
||
|
||
$.html()
|
||
//=> <h2 class="title welcome">Hello there!</h2>
|
||
```
|
||
|
||
## Installation
|
||
`npm install cheerio`
|
||
|
||
## Features
|
||
__❤ Familiar syntax:__
|
||
Cheerio implements a subset of core jQuery. Cheerio removes all the DOM inconsistencies and browser cruft from the jQuery library, revealing its truly gorgeous API.
|
||
|
||
__ϟ Blazingly fast:__
|
||
Cheerio works with a very simple, consistent DOM model. As a result parsing, manipulating, and rendering are incredibly efficient. Preliminary end-to-end benchmarks suggest that cheerio is about __8x__ faster than JSDOM.
|
||
|
||
__❁ Incredibly flexible:__
|
||
Cheerio wraps around @FB55's forgiving [htmlparser2](https://github.com/fb55/htmlparser2/). Cheerio can parse nearly any HTML or XML document.
|
||
|
||
## Sponsors
|
||
|
||
Does your company use Cheerio in production? Please consider [sponsoring this project](https://opencollective.com/cheerio#sponsor). Your help will allow maintainers to dedicate more time and resources to its development and support.
|
||
|
||
<a href="https://opencollective.com/cheerio/sponsor/0/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/0/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/1/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/1/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/2/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/2/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/3/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/3/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/4/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/4/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/5/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/5/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/6/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/6/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/7/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/7/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/8/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/8/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/9/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/9/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/10/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/10/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/11/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/11/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/12/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/12/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/13/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/13/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/14/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/14/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/15/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/15/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/16/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/16/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/17/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/17/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/18/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/18/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/19/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/19/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/20/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/20/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/21/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/21/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/22/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/22/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/23/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/23/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/24/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/24/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/25/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/25/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/26/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/26/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/27/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/27/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/28/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/28/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/sponsor/29/website" target="_blank"><img src="https://opencollective.com/cheerio/sponsor/29/avatar.svg"></a>
|
||
|
||
## Backers
|
||
|
||
[Become a backer](https://opencollective.com/cheerio#backer) to show your support for Cheerio and help us maintain and improve this open source project.
|
||
|
||
<a href="https://opencollective.com/cheerio/backer/0/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/0/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/1/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/1/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/2/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/2/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/3/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/3/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/4/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/4/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/5/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/5/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/6/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/6/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/7/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/7/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/8/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/8/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/9/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/9/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/10/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/10/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/11/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/11/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/12/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/12/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/13/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/13/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/14/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/14/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/15/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/15/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/16/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/16/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/17/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/17/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/18/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/18/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/19/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/19/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/20/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/20/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/21/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/21/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/22/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/22/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/23/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/23/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/24/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/24/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/25/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/25/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/26/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/26/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/27/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/27/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/28/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/28/avatar.svg"></a>
|
||
<a href="https://opencollective.com/cheerio/backer/29/website" target="_blank"><img src="https://opencollective.com/cheerio/backer/29/avatar.svg"></a>
|
||
|
||
## API
|
||
|
||
### Markup example we'll be using:
|
||
|
||
```html
|
||
<ul id="fruits">
|
||
<li class="apple">Apple</li>
|
||
<li class="orange">Orange</li>
|
||
<li class="pear">Pear</li>
|
||
</ul>
|
||
```
|
||
|
||
This is the HTML markup we will be using in all of the API examples.
|
||
|
||
### Loading
|
||
First you need to load in the HTML. This step in jQuery is implicit, since jQuery operates on the one, baked-in DOM. With Cheerio, we need to pass in the HTML document.
|
||
|
||
This is the _preferred_ method:
|
||
|
||
```js
|
||
var cheerio = require('cheerio'),
|
||
$ = cheerio.load('<ul id="fruits">...</ul>');
|
||
```
|
||
|
||
Optionally, you can also load in the HTML by passing the string as the context:
|
||
|
||
```js
|
||
$ = require('cheerio');
|
||
$('ul', '<ul id="fruits">...</ul>');
|
||
```
|
||
|
||
Or as the root:
|
||
|
||
```js
|
||
$ = require('cheerio');
|
||
$('li', 'ul', '<ul id="fruits">...</ul>');
|
||
```
|
||
|
||
You can also pass an extra object to `.load()` if you need to modify any
|
||
of the default parsing options:
|
||
|
||
```js
|
||
$ = cheerio.load('<ul id="fruits">...</ul>', {
|
||
normalizeWhitespace: true,
|
||
xmlMode: true
|
||
});
|
||
```
|
||
|
||
These parsing options are taken directly from [htmlparser2](https://github.com/fb55/htmlparser2/wiki/Parser-options), therefore any options that can be used in `htmlparser2` are valid in cheerio as well. The default options are:
|
||
|
||
```js
|
||
{
|
||
withDomLvl1: true,
|
||
normalizeWhitespace: false,
|
||
xmlMode: false,
|
||
decodeEntities: true
|
||
}
|
||
|
||
```
|
||
|
||
For a full list of options and their effects, see [this](https://github.com/fb55/DomHandler) and
|
||
[htmlparser2's options](https://github.com/fb55/htmlparser2/wiki/Parser-options).
|
||
|
||
### Selectors
|
||
|
||
Cheerio's selector implementation is nearly identical to jQuery's, so the API is very similar.
|
||
|
||
#### $( selector, [context], [root] )
|
||
`selector` searches within the `context` scope which searches within the `root` scope. `selector` and `context` can be a string expression, DOM Element, array of DOM elements, or cheerio object. `root` is typically the HTML document string.
|
||
|
||
This selector method is the starting point for traversing and manipulating the document. Like jQuery, it's the primary method for selecting elements in the document, but unlike jQuery it's built on top of the CSSSelect library, which implements most of the Sizzle selectors.
|
||
|
||
```js
|
||
$('.apple', '#fruits').text()
|
||
//=> Apple
|
||
|
||
$('ul .pear').attr('class')
|
||
//=> pear
|
||
|
||
$('li[class=orange]').html()
|
||
//=> Orange
|
||
```
|
||
|
||
### Attributes
|
||
Methods for getting and modifying attributes.
|
||
|
||
#### .attr( name, value )
|
||
Method for getting and setting attributes. Gets the attribute value for only the first element in the matched set. If you set an attribute's value to `null`, you remove that attribute. You may also pass a `map` and `function` like jQuery.
|
||
|
||
```js
|
||
$('ul').attr('id')
|
||
//=> fruits
|
||
|
||
$('.apple').attr('id', 'favorite').html()
|
||
//=> <li class="apple" id="favorite">Apple</li>
|
||
```
|
||
|
||
> See http://api.jquery.com/attr/ for more information
|
||
|
||
#### .prop( name, value )
|
||
Method for getting and setting properties. Gets the property value for only the first element in the matched set.
|
||
|
||
```js
|
||
$('input[type="checkbox"]').prop('checked')
|
||
//=> false
|
||
|
||
$('input[type="checkbox"]').prop('checked', true).val()
|
||
//=> ok
|
||
```
|
||
|
||
> See http://api.jquery.com/prop/ for more information
|
||
|
||
#### .data( name, value )
|
||
Method for getting and setting data attributes. Gets or sets the data attribute value for only the first element in the matched set.
|
||
|
||
```js
|
||
$('<div data-apple-color="red"></div>').data()
|
||
//=> { appleColor: 'red' }
|
||
|
||
$('<div data-apple-color="red"></div>').data('apple-color')
|
||
//=> 'red'
|
||
|
||
var apple = $('.apple').data('kind', 'mac')
|
||
apple.data('kind')
|
||
//=> 'mac'
|
||
```
|
||
|
||
> See http://api.jquery.com/data/ for more information
|
||
|
||
#### .val( [value] )
|
||
Method for getting and setting the value of input, select, and textarea. Note: Support for `map`, and `function` has not been added yet.
|
||
|
||
```js
|
||
$('input[type="text"]').val()
|
||
//=> input_text
|
||
|
||
$('input[type="text"]').val('test').html()
|
||
//=> <input type="text" value="test"/>
|
||
```
|
||
|
||
#### .removeAttr( name )
|
||
Method for removing attributes by `name`.
|
||
|
||
```js
|
||
$('.pear').removeAttr('class').html()
|
||
//=> <li>Pear</li>
|
||
```
|
||
|
||
#### .hasClass( className )
|
||
Check to see if *any* of the matched elements have the given `className`.
|
||
|
||
```js
|
||
$('.pear').hasClass('pear')
|
||
//=> true
|
||
|
||
$('apple').hasClass('fruit')
|
||
//=> false
|
||
|
||
$('li').hasClass('pear')
|
||
//=> true
|
||
```
|
||
|
||
#### .addClass( className )
|
||
Adds class(es) to all of the matched elements. Also accepts a `function` like jQuery.
|
||
|
||
```js
|
||
$('.pear').addClass('fruit').html()
|
||
//=> <li class="pear fruit">Pear</li>
|
||
|
||
$('.apple').addClass('fruit red').html()
|
||
//=> <li class="apple fruit red">Apple</li>
|
||
```
|
||
|
||
> See http://api.jquery.com/addClass/ for more information.
|
||
|
||
#### .removeClass( [className] )
|
||
Removes one or more space-separated classes from the selected elements. If no `className` is defined, all classes will be removed. Also accepts a `function` like jQuery.
|
||
|
||
```js
|
||
$('.pear').removeClass('pear').html()
|
||
//=> <li class="">Pear</li>
|
||
|
||
$('.apple').addClass('red').removeClass().html()
|
||
//=> <li class="">Apple</li>
|
||
```
|
||
|
||
> See http://api.jquery.com/removeClass/ for more information.
|
||
|
||
#### .toggleClass( className, [switch] )
|
||
Add or remove class(es) from the matched elements, depending on either the class's presence or the value of the switch argument. Also accepts a `function` like jQuery.
|
||
|
||
```js
|
||
$('.apple.green').toggleClass('fruit green red').html()
|
||
//=> <li class="apple fruit red">Apple</li>
|
||
|
||
$('.apple.green').toggleClass('fruit green red', true).html()
|
||
//=> <li class="apple green fruit red">Apple</li>
|
||
```
|
||
|
||
> See http://api.jquery.com/toggleClass/ for more information.
|
||
|
||
#### .is( selector )
|
||
#### .is( element )
|
||
#### .is( selection )
|
||
#### .is( function(index) )
|
||
Checks the current list of elements and returns `true` if _any_ of the elements match the selector. If using an element or Cheerio selection, returns `true` if _any_ of the elements match. If using a predicate function, the function is executed in the context of the selected element, so `this` refers to the current element.
|
||
|
||
### Forms
|
||
|
||
#### .serializeArray()
|
||
|
||
Encode a set of form elements as an array of names and values.
|
||
|
||
```js
|
||
$('<form><input name="foo" value="bar" /></form>').serializeArray()
|
||
//=> [ { name: 'foo', value: 'bar' } ]
|
||
```
|
||
|
||
### Traversing
|
||
|
||
#### .find(selector)
|
||
#### .find(selection)
|
||
#### .find(node)
|
||
Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.
|
||
|
||
```js
|
||
$('#fruits').find('li').length
|
||
//=> 3
|
||
$('#fruits').find($('.apple')).length
|
||
//=> 1
|
||
```
|
||
|
||
#### .parent([selector])
|
||
Get the parent of each element in the current set of matched elements, optionally filtered by a selector.
|
||
|
||
```js
|
||
$('.pear').parent().attr('id')
|
||
//=> fruits
|
||
```
|
||
|
||
#### .parents([selector])
|
||
Get a set of parents filtered by `selector` of each element in the current set of match elements.
|
||
```js
|
||
$('.orange').parents().length
|
||
// => 2
|
||
$('.orange').parents('#fruits').length
|
||
// => 1
|
||
```
|
||
|
||
#### .parentsUntil([selector][,filter])
|
||
Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector, DOM node, or cheerio object.
|
||
```js
|
||
$('.orange').parentsUntil('#food').length
|
||
// => 1
|
||
```
|
||
|
||
#### .closest(selector)
|
||
For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.
|
||
|
||
```js
|
||
$('.orange').closest()
|
||
// => []
|
||
$('.orange').closest('.apple')
|
||
// => []
|
||
$('.orange').closest('li')
|
||
// => [<li class="orange">Orange</li>]
|
||
$('.orange').closest('#fruits')
|
||
// => [<ul id="fruits"> ... </ul>]
|
||
```
|
||
|
||
#### .next([selector])
|
||
Gets the next sibling of the first selected element, optionally filtered by a selector.
|
||
|
||
```js
|
||
$('.apple').next().hasClass('orange')
|
||
//=> true
|
||
```
|
||
|
||
#### .nextAll([selector])
|
||
Gets all the following siblings of the first selected element, optionally filtered by a selector.
|
||
|
||
```js
|
||
$('.apple').nextAll()
|
||
//=> [<li class="orange">Orange</li>, <li class="pear">Pear</li>]
|
||
$('.apple').nextAll('.orange')
|
||
//=> [<li class="orange">Orange</li>]
|
||
```
|
||
|
||
#### .nextUntil([selector], [filter])
|
||
Gets all the following siblings up to but not including the element matched by the selector, optionally filtered by another selector.
|
||
|
||
```js
|
||
$('.apple').nextUntil('.pear')
|
||
//=> [<li class="orange">Orange</li>]
|
||
```
|
||
|
||
#### .prev([selector])
|
||
Gets the previous sibling of the first selected element optionally filtered by a selector.
|
||
|
||
```js
|
||
$('.orange').prev().hasClass('apple')
|
||
//=> true
|
||
```
|
||
|
||
#### .prevAll([selector])
|
||
Gets all the preceding siblings of the first selected element, optionally filtered by a selector.
|
||
|
||
```js
|
||
$('.pear').prevAll()
|
||
//=> [<li class="orange">Orange</li>, <li class="apple">Apple</li>]
|
||
$('.pear').prevAll('.orange')
|
||
//=> [<li class="orange">Orange</li>]
|
||
```
|
||
|
||
#### .prevUntil([selector], [filter])
|
||
Gets all the preceding siblings up to but not including the element matched by the selector, optionally filtered by another selector.
|
||
|
||
```js
|
||
$('.pear').prevUntil('.apple')
|
||
//=> [<li class="orange">Orange</li>]
|
||
```
|
||
|
||
#### .slice( start, [end] )
|
||
Gets the elements matching the specified range
|
||
|
||
```js
|
||
$('li').slice(1).eq(0).text()
|
||
//=> 'Orange'
|
||
|
||
$('li').slice(1, 2).length
|
||
//=> 1
|
||
```
|
||
|
||
#### .siblings([selector])
|
||
Gets the first selected element's siblings, excluding itself.
|
||
|
||
```js
|
||
$('.pear').siblings().length
|
||
//=> 2
|
||
|
||
$('.pear').siblings('.orange').length
|
||
//=> 1
|
||
|
||
```
|
||
|
||
#### .children([selector])
|
||
Gets the children of the first selected element.
|
||
|
||
```js
|
||
$('#fruits').children().length
|
||
//=> 3
|
||
|
||
$('#fruits').children('.pear').text()
|
||
//=> Pear
|
||
```
|
||
|
||
#### .contents()
|
||
Gets the children of each element in the set of matched elements, including text and comment nodes.
|
||
|
||
```js
|
||
$('#fruits').contents().length
|
||
//=> 3
|
||
```
|
||
|
||
#### .each( function(index, element) )
|
||
Iterates over a cheerio object, executing a function for each matched element. When the callback is fired, the function is fired in the context of the DOM element, so `this` refers to the current element, which is equivalent to the function parameter `element`. To break out of the `each` loop early, return with `false`.
|
||
|
||
```js
|
||
var fruits = [];
|
||
|
||
$('li').each(function(i, elem) {
|
||
fruits[i] = $(this).text();
|
||
});
|
||
|
||
fruits.join(', ');
|
||
//=> Apple, Orange, Pear
|
||
```
|
||
|
||
#### .map( function(index, element) )
|
||
Pass each element in the current matched set through a function, producing a new Cheerio object containing the return values. The function can return an individual data item or an array of data items to be inserted into the resulting set. If an array is returned, the elements inside the array are inserted into the set. If the function returns null or undefined, no element will be inserted.
|
||
|
||
```js
|
||
$('li').map(function(i, el) {
|
||
// this === el
|
||
return $(this).text();
|
||
}).get().join(' ');
|
||
//=> "apple orange pear"
|
||
```
|
||
|
||
#### .filter( selector ) <br /> .filter( selection ) <br /> .filter( element ) <br /> .filter( function(index) )
|
||
|
||
Iterates over a cheerio object, reducing the set of selector elements to those that match the selector or pass the function's test. When a Cheerio selection is specified, return only the elements contained in that selection. When an element is specified, return only that element (if it is contained in the original selection). If using the function method, the function is executed in the context of the selected element, so `this` refers to the current element.
|
||
|
||
Selector:
|
||
|
||
```js
|
||
$('li').filter('.orange').attr('class');
|
||
//=> orange
|
||
```
|
||
|
||
Function:
|
||
|
||
```js
|
||
$('li').filter(function(i, el) {
|
||
// this === el
|
||
return $(this).attr('class') === 'orange';
|
||
}).attr('class')
|
||
//=> orange
|
||
```
|
||
|
||
#### .not( selector ) <br /> .not( selection ) <br /> .not( element ) <br /> .not( function(index, elem) )
|
||
|
||
Remove elements from the set of matched elements. Given a jQuery object that represents a set of DOM elements, the `.not()` method constructs a new jQuery object from a subset of the matching elements. The supplied selector is tested against each element; the elements that don't match the selector will be included in the result. The `.not()` method can take a function as its argument in the same way that `.filter()` does. Elements for which the function returns true are excluded from the filtered set; all other elements are included.
|
||
|
||
Selector:
|
||
|
||
```js
|
||
$('li').not('.apple').length;
|
||
//=> 2
|
||
```
|
||
|
||
Function:
|
||
|
||
```js
|
||
$('li').not(function(i, el) {
|
||
// this === el
|
||
return $(this).attr('class') === 'orange';
|
||
}).length;
|
||
//=> 2
|
||
```
|
||
|
||
#### .has( selector ) <br /> .has( element )
|
||
|
||
Filters the set of matched elements to only those which have the given DOM element as a descendant or which have a descendant that matches the given selector. Equivalent to `.filter(':has(selector)')`.
|
||
|
||
Selector:
|
||
|
||
```js
|
||
$('ul').has('.pear').attr('id');
|
||
//=> fruits
|
||
```
|
||
|
||
Element:
|
||
|
||
```js
|
||
$('ul').has($('.pear')[0]).attr('id');
|
||
//=> fruits
|
||
```
|
||
|
||
#### .first()
|
||
Will select the first element of a cheerio object
|
||
|
||
```js
|
||
$('#fruits').children().first().text()
|
||
//=> Apple
|
||
```
|
||
|
||
#### .last()
|
||
Will select the last element of a cheerio object
|
||
|
||
```js
|
||
$('#fruits').children().last().text()
|
||
//=> Pear
|
||
```
|
||
|
||
#### .eq( i )
|
||
Reduce the set of matched elements to the one at the specified index. Use `.eq(-i)` to count backwards from the last selected element.
|
||
|
||
```js
|
||
$('li').eq(0).text()
|
||
//=> Apple
|
||
|
||
$('li').eq(-1).text()
|
||
//=> Pear
|
||
```
|
||
|
||
#### .get( [i] )
|
||
|
||
Retrieve the DOM elements matched by the Cheerio object. If an index is specified, retrieve one of the elements matched by the Cheerio object:
|
||
|
||
```js
|
||
$('li').get(0).tagName
|
||
//=> li
|
||
```
|
||
|
||
If no index is specified, retrieve all elements matched by the Cheerio object:
|
||
|
||
```js
|
||
$('li').get().length
|
||
//=> 3
|
||
```
|
||
|
||
#### .index()
|
||
#### .index( selector )
|
||
#### .index( nodeOrSelection )
|
||
|
||
Search for a given element from among the matched elements.
|
||
|
||
```js
|
||
$('.pear').index()
|
||
//=> 2
|
||
$('.orange').index('li')
|
||
//=> 1
|
||
$('.apple').index($('#fruit, li'))
|
||
//=> 1
|
||
```
|
||
|
||
#### .end()
|
||
End the most recent filtering operation in the current chain and return the set of matched elements to its previous state.
|
||
|
||
```js
|
||
$('li').eq(0).end().length
|
||
//=> 3
|
||
```
|
||
|
||
#### .add( selector [, context] )
|
||
#### .add( element )
|
||
#### .add( elements )
|
||
#### .add( html )
|
||
#### .add( selection )
|
||
Add elements to the set of matched elements.
|
||
|
||
```js
|
||
$('.apple').add('.orange').length
|
||
//=> 2
|
||
```
|
||
|
||
#### .addBack( [filter] )
|
||
|
||
Add the previous set of elements on the stack to the current set, optionally filtered by a selector.
|
||
|
||
```js
|
||
$('li').eq(0).addBack('.orange').length
|
||
//=> 2
|
||
```
|
||
|
||
### Manipulation
|
||
Methods for modifying the DOM structure.
|
||
|
||
#### .append( content, [content, ...] )
|
||
Inserts content as the *last* child of each of the selected elements.
|
||
|
||
```js
|
||
$('ul').append('<li class="plum">Plum</li>')
|
||
$.html()
|
||
//=> <ul id="fruits">
|
||
// <li class="apple">Apple</li>
|
||
// <li class="orange">Orange</li>
|
||
// <li class="pear">Pear</li>
|
||
// <li class="plum">Plum</li>
|
||
// </ul>
|
||
```
|
||
|
||
#### .appendTo( target )
|
||
Insert every element in the set of matched elements to the end of the target.
|
||
|
||
```js
|
||
$('<li class="plum">Plum</li>').appendTo('#fruits')
|
||
$.html()
|
||
//=> <ul id="fruits">
|
||
// <li class="apple">Apple</li>
|
||
// <li class="orange">Orange</li>
|
||
// <li class="pear">Pear</li>
|
||
// <li class="plum">Plum</li>
|
||
// </ul>
|
||
```
|
||
|
||
#### .prepend( content, [content, ...] )
|
||
Inserts content as the *first* child of each of the selected elements.
|
||
|
||
```js
|
||
$('ul').prepend('<li class="plum">Plum</li>')
|
||
$.html()
|
||
//=> <ul id="fruits">
|
||
// <li class="plum">Plum</li>
|
||
// <li class="apple">Apple</li>
|
||
// <li class="orange">Orange</li>
|
||
// <li class="pear">Pear</li>
|
||
// </ul>
|
||
```
|
||
|
||
#### .prependTo( target )
|
||
Insert every element in the set of matched elements to the beginning of the target.
|
||
|
||
```js
|
||
$('<li class="plum">Plum</li>').prependTo('#fruits')
|
||
$.html()
|
||
//=> <ul id="fruits">
|
||
// <li class="plum">Plum</li>
|
||
// <li class="apple">Apple</li>
|
||
// <li class="orange">Orange</li>
|
||
// <li class="pear">Pear</li>
|
||
// </ul>
|
||
```
|
||
|
||
#### .after( content, [content, ...] )
|
||
Insert content next to each element in the set of matched elements.
|
||
|
||
```js
|
||
$('.apple').after('<li class="plum">Plum</li>')
|
||
$.html()
|
||
//=> <ul id="fruits">
|
||
// <li class="apple">Apple</li>
|
||
// <li class="plum">Plum</li>
|
||
// <li class="orange">Orange</li>
|
||
// <li class="pear">Pear</li>
|
||
// </ul>
|
||
```
|
||
|
||
#### .insertAfter( target )
|
||
Insert every element in the set of matched elements after the target.
|
||
|
||
```js
|
||
$('<li class="plum">Plum</li>').insertAfter('.apple')
|
||
$.html()
|
||
//=> <ul id="fruits">
|
||
// <li class="apple">Apple</li>
|
||
// <li class="plum">Plum</li>
|
||
// <li class="orange">Orange</li>
|
||
// <li class="pear">Pear</li>
|
||
// </ul>
|
||
```
|
||
|
||
#### .before( content, [content, ...] )
|
||
Insert content previous to each element in the set of matched elements.
|
||
|
||
```js
|
||
$('.apple').before('<li class="plum">Plum</li>')
|
||
$.html()
|
||
//=> <ul id="fruits">
|
||
// <li class="plum">Plum</li>
|
||
// <li class="apple">Apple</li>
|
||
// <li class="orange">Orange</li>
|
||
// <li class="pear">Pear</li>
|
||
// </ul>
|
||
```
|
||
|
||
#### .insertBefore( target )
|
||
Insert every element in the set of matched elements before the target.
|
||
|
||
```js
|
||
$('<li class="plum">Plum</li>').insertBefore('.apple')
|
||
$.html()
|
||
//=> <ul id="fruits">
|
||
// <li class="plum">Plum</li>
|
||
// <li class="apple">Apple</li>
|
||
// <li class="orange">Orange</li>
|
||
// <li class="pear">Pear</li>
|
||
// </ul>
|
||
```
|
||
|
||
#### .remove( [selector] )
|
||
Removes the set of matched elements from the DOM and all their children. `selector` filters the set of matched elements to be removed.
|
||
|
||
```js
|
||
$('.pear').remove()
|
||
$.html()
|
||
//=> <ul id="fruits">
|
||
// <li class="apple">Apple</li>
|
||
// <li class="orange">Orange</li>
|
||
// </ul>
|
||
```
|
||
|
||
#### .replaceWith( content )
|
||
Replaces matched elements with `content`.
|
||
|
||
```js
|
||
var plum = $('<li class="plum">Plum</li>')
|
||
$('.pear').replaceWith(plum)
|
||
$.html()
|
||
//=> <ul id="fruits">
|
||
// <li class="apple">Apple</li>
|
||
// <li class="orange">Orange</li>
|
||
// <li class="plum">Plum</li>
|
||
// </ul>
|
||
```
|
||
|
||
#### .empty()
|
||
Empties an element, removing all its children.
|
||
|
||
```js
|
||
$('ul').empty()
|
||
$.html()
|
||
//=> <ul id="fruits"></ul>
|
||
```
|
||
|
||
#### .html( [htmlString] )
|
||
Gets an html content string from the first selected element. If `htmlString` is specified, each selected element's content is replaced by the new content.
|
||
|
||
```js
|
||
$('.orange').html()
|
||
//=> Orange
|
||
|
||
$('#fruits').html('<li class="mango">Mango</li>').html()
|
||
//=> <li class="mango">Mango</li>
|
||
```
|
||
|
||
#### .text( [textString] )
|
||
Get the combined text contents of each element in the set of matched elements, including their descendants.. If `textString` is specified, each selected element's content is replaced by the new text content.
|
||
|
||
```js
|
||
$('.orange').text()
|
||
//=> Orange
|
||
|
||
$('ul').text()
|
||
//=> Apple
|
||
// Orange
|
||
// Pear
|
||
```
|
||
|
||
#### .wrap( content )
|
||
The .wrap() function can take any string or object that could be passed to the $() factory function to specify a DOM structure. This structure may be nested several levels deep, but should contain only one inmost element. A copy of this structure will be wrapped around each of the elements in the set of matched elements. This method returns the original set of elements for chaining purposes.
|
||
|
||
```js
|
||
var redFruit = $('<div class="red-fruit"></div>')
|
||
$('.apple').wrap(redFruit)
|
||
|
||
//=> <ul id="fruits">
|
||
// <div class="red-fruit">
|
||
// <li class="apple">Apple</li>
|
||
// </div>
|
||
// <li class="orange">Orange</li>
|
||
// <li class="plum">Plum</li>
|
||
// </ul>
|
||
|
||
var healthy = $('<div class="healthy"></div>')
|
||
$('li').wrap(healthy)
|
||
|
||
//=> <ul id="fruits">
|
||
// <div class="healthy">
|
||
// <li class="apple">Apple</li>
|
||
// </div>
|
||
// <div class="healthy">
|
||
// <li class="orange">Orange</li>
|
||
// </div>
|
||
// <div class="healthy">
|
||
// <li class="plum">Plum</li>
|
||
// </div>
|
||
// </ul>
|
||
```
|
||
|
||
#### .css( [propertName] ) <br /> .css( [ propertyNames] ) <br /> .css( [propertyName], [value] ) <br /> .css( [propertName], [function] ) <br /> .css( [properties] )
|
||
|
||
Get the value of a style property for the first element in the set of matched elements or set one or more CSS properties for every matched element.
|
||
|
||
### Rendering
|
||
When you're ready to render the document, you can use the `html` utility function:
|
||
|
||
```js
|
||
$.html()
|
||
//=> <ul id="fruits">
|
||
// <li class="apple">Apple</li>
|
||
// <li class="orange">Orange</li>
|
||
// <li class="pear">Pear</li>
|
||
// </ul>
|
||
```
|
||
|
||
If you want to return the outerHTML you can use `$.html(selector)`:
|
||
|
||
```js
|
||
$.html('.pear')
|
||
//=> <li class="pear">Pear</li>
|
||
```
|
||
|
||
By default, `html` will leave some tags open. Sometimes you may instead want to render a valid XML document. For example, you might parse the following XML snippet:
|
||
|
||
```xml
|
||
$ = cheerio.load('<media:thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123"/>');
|
||
```
|
||
|
||
... and later want to render to XML. To do this, you can use the 'xml' utility function:
|
||
|
||
```js
|
||
$.xml()
|
||
//=> <media:thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123"/>
|
||
```
|
||
|
||
You may also render the text content of a Cheerio object using the `text` static method:
|
||
|
||
```js
|
||
$ = cheerio.load('This is <em>content</em>.')
|
||
$.text()
|
||
//=> This is content.
|
||
```
|
||
|
||
The method may be called on the Cheerio module itself--be sure to pass a collection of nodes!
|
||
|
||
```js
|
||
$ = cheerio.load('<div>This is <em>content</em>.</div>')
|
||
cheerio.text($('div'))
|
||
//=> This is content.
|
||
```
|
||
|
||
### Miscellaneous
|
||
DOM element methods that don't fit anywhere else
|
||
|
||
#### .toArray()
|
||
Retrieve all the DOM elements contained in the jQuery set as an array.
|
||
|
||
```js
|
||
$('li').toArray()
|
||
//=> [ {...}, {...}, {...} ]
|
||
```
|
||
|
||
#### .clone() ####
|
||
Clone the cheerio object.
|
||
|
||
```js
|
||
var moreFruit = $('#fruits').clone()
|
||
```
|
||
|
||
### Utilities
|
||
|
||
#### $.root
|
||
|
||
Sometimes you need to work with the top-level root element. To query it, you can use `$.root()`.
|
||
|
||
```js
|
||
$.root().append('<ul id="vegetables"></ul>').html();
|
||
//=> <ul id="fruits">...</ul><ul id="vegetables"></ul>
|
||
```
|
||
|
||
#### $.contains( container, contained )
|
||
Checks to see if the `contained` DOM element is a descendant of the `container` DOM element.
|
||
|
||
#### $.parseHTML( data [, context ] [, keepScripts ] )
|
||
Parses a string into an array of DOM nodes. The `context` argument has no meaning for Cheerio, but it is maintained for API compatability.
|
||
|
||
#### $.load( html[, options ] )
|
||
Load in the HTML. (See the previous section titled "Loading" for more information.)
|
||
|
||
### Plugins
|
||
|
||
Once you have loaded a document, you may extend the prototype or the equivalent `fn` property with custom plugin methods:
|
||
|
||
```js
|
||
var $ = cheerio.load('<html><body>Hello, <b>world</b>!</body></html>');
|
||
$.prototype.logHtml = function() {
|
||
console.log(this.html());
|
||
};
|
||
|
||
$('body').logHtml(); // logs "Hello, <b>world</b>!" to the console
|
||
```
|
||
|
||
### The "DOM Node" object
|
||
|
||
Cheerio collections are made up of objects that bear some resemblence to [browser-based DOM nodes](https://developer.mozilla.org/en-US/docs/Web/API/Node). You can expect them to define the following properties:
|
||
|
||
- `tagName`
|
||
- `parentNode`
|
||
- `previousSibling`
|
||
- `nextSibling`
|
||
- `nodeValue`
|
||
- `firstChild`
|
||
- `childNodes`
|
||
- `lastChild`
|
||
|
||
## What about JSDOM?
|
||
I wrote cheerio because I found myself increasingly frustrated with JSDOM. For me, there were three main sticking points that I kept running into again and again:
|
||
|
||
__• JSDOM's built-in parser is too strict:__
|
||
JSDOM's bundled HTML parser cannot handle many popular sites out there today.
|
||
|
||
__• JSDOM is too slow:__
|
||
Parsing big websites with JSDOM has a noticeable delay.
|
||
|
||
__• JSDOM feels too heavy:__
|
||
The goal of JSDOM is to provide an identical DOM environment as what we see in the browser. I never really needed all this, I just wanted a simple, familiar way to do HTML manipulation.
|
||
|
||
## When I would use JSDOM
|
||
|
||
Cheerio will not solve all your problems. I would still use JSDOM if I needed to work in a browser-like environment on the server, particularly if I wanted to automate functional tests.
|
||
|
||
## Screencasts
|
||
|
||
http://vimeo.com/31950192
|
||
|
||
> This video tutorial is a follow-up to Nettut's "How to Scrape Web Pages with Node.js and jQuery", using cheerio instead of JSDOM + jQuery. This video shows how easy it is to use cheerio and how much faster cheerio is than JSDOM + jQuery.
|
||
|
||
## Contributors
|
||
|
||
These are some of the contributors that have made cheerio possible:
|
||
|
||
```
|
||
project : cheerio
|
||
repo age : 2 years, 6 months
|
||
active : 285 days
|
||
commits : 762
|
||
files : 36
|
||
authors :
|
||
293 Matt Mueller 38.5%
|
||
133 Matthew Mueller 17.5%
|
||
92 Mike Pennisi 12.1%
|
||
54 David Chambers 7.1%
|
||
30 kpdecker 3.9%
|
||
19 Felix Böhm 2.5%
|
||
17 fb55 2.2%
|
||
15 Siddharth Mahendraker 2.0%
|
||
11 Adam Bretz 1.4%
|
||
8 Nazar Leush 1.0%
|
||
7 ironchefpython 0.9%
|
||
6 Jarno Leppänen 0.8%
|
||
5 Ben Sheldon 0.7%
|
||
5 Jos Shepherd 0.7%
|
||
5 Ryan Schmukler 0.7%
|
||
5 Steven Vachon 0.7%
|
||
4 Maciej Adwent 0.5%
|
||
4 Amir Abu Shareb 0.5%
|
||
3 jeremy.dentel@brandingbrand.com 0.4%
|
||
3 Andi Neck 0.4%
|
||
2 steve 0.3%
|
||
2 alexbardas 0.3%
|
||
2 finspin 0.3%
|
||
2 Ali Farhadi 0.3%
|
||
2 Chris Khoo 0.3%
|
||
2 Rob Ashton 0.3%
|
||
2 Thomas Heymann 0.3%
|
||
2 Jaro Spisak 0.3%
|
||
2 Dan Dascalescu 0.3%
|
||
2 Torstein Thune 0.3%
|
||
2 Wayne Larsen 0.3%
|
||
1 Timm Preetz 0.1%
|
||
1 Xavi 0.1%
|
||
1 Alex Shaindlin 0.1%
|
||
1 mattym 0.1%
|
||
1 Felix Böhm 0.1%
|
||
1 Farid Neshat 0.1%
|
||
1 Dmitry Mazuro 0.1%
|
||
1 Jeremy Hubble 0.1%
|
||
1 nevermind 0.1%
|
||
1 Manuel Alabor 0.1%
|
||
1 Matt Liegey 0.1%
|
||
1 Chris O'Hara 0.1%
|
||
1 Michael Holroyd 0.1%
|
||
1 Michiel De Mey 0.1%
|
||
1 Ben Atkin 0.1%
|
||
1 Rich Trott 0.1%
|
||
1 Rob "Hurricane" Ashton 0.1%
|
||
1 Robin Gloster 0.1%
|
||
1 Simon Boudrias 0.1%
|
||
1 Sindre Sorhus 0.1%
|
||
1 xiaohwan 0.1%
|
||
```
|
||
|
||
## Cheerio in the real world
|
||
|
||
Are you using cheerio in production? Add it to the [wiki](https://github.com/cheeriojs/cheerio/wiki/Cheerio-in-Production)!
|
||
|
||
## Testing
|
||
|
||
To run the test suite, download the repository, then within the cheerio directory, run:
|
||
|
||
```shell
|
||
make setup
|
||
make test
|
||
```
|
||
|
||
This will download the development packages and run the test suite.
|
||
|
||
## Special Thanks
|
||
|
||
This library stands on the shoulders of some incredible developers. A special thanks to:
|
||
|
||
__• @FB55 for node-htmlparser2 & CSSSelect:__
|
||
Felix has a knack for writing speedy parsing engines. He completely re-wrote both @tautologistic's `node-htmlparser` and @harry's `node-soupselect` from the ground up, making both of them much faster and more flexible. Cheerio would not be possible without his foundational work
|
||
|
||
__• @jQuery team for jQuery:__
|
||
The core API is the best of its class and despite dealing with all the browser inconsistencies the code base is extremely clean and easy to follow. Much of cheerio's implementation and documentation is from jQuery. Thanks guys.
|
||
|
||
__• @visionmedia:__
|
||
The style, the structure, the open-source"-ness" of this library comes from studying TJ's style and using many of his libraries. This dude consistently pumps out high-quality libraries and has always been more than willing to help or answer questions. You rock TJ.
|
||
|
||
## License
|
||
|
||
MIT
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- cloudinary-core@2.11.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
[](https://travis-ci.org/cloudinary/cloudinary_js) []() []() []()
|
||
|
||
:information_source: This is a distribution repository for `bower` and `npm`. The sources for this repository are maintained at the [cloudinary_js repository](https://github.com/cloudinary/cloudinary_js). Please submit issues and pull requests to that repository.
|
||
|
||
# Cloudinary Client Side JavaScript Library<br>`bower` and `npm` repository
|
||
|
||
Cloudinary is a cloud service that offers a solution to a web application's entire image management pipeline.
|
||
|
||
Easily upload images to the cloud. Automatically perform smart image resizing, cropping and conversion without installing any complex software. Integrate Facebook or Twitter profile image extraction in a snap, in any dimension and style to match your website’s graphics requirements. Images are seamlessly delivered through a fast CDN, and much much more.
|
||
|
||
Cloudinary offers comprehensive APIs and administration capabilities and is easy to integrate with any web application, existing or new.
|
||
|
||
Cloudinary provides URL and HTTP based APIs that can be easily integrated with any Web development framework.
|
||
|
||
## Getting started guide
|
||
|
||
 **Take a look at our [Getting started guide for jQuery](http://cloudinary.com/documentation/jquery_integration#getting_started_guide)**. (Core JavaScript documentation coming soon.)
|
||
|
||
|
||
## Installation
|
||
|
||
### bower
|
||
|
||
1. Install the files using the following command. Use the optional `--save` parameter if you wish to save the dependency in your bower.json file.
|
||
|
||
```shell
|
||
bower install cloudinary-core
|
||
```
|
||
1. Include the javascript file in your HTML. For Example:
|
||
|
||
```html
|
||
<script src="bower_components/lodash/lodash.js" type="text/javascript"></script>
|
||
<script src="bower_components/cloudinary-core/cloudinary-core.js" type="text/javascript"></script>
|
||
```
|
||
|
||
If you do not intend to use `lodash` in your own code, you can instead use the shrinkwrap version which includes a subset
|
||
of the lodash functions. This reduces the loaded code by about 50%!
|
||
|
||
```html
|
||
<script src="bower_components/cloudinary-core/cloudinary-core-shrinkwrap.js" type="text/javascript"></script>
|
||
```
|
||
### NPM
|
||
The following instructions describe the installation of the **client-side libraries**. For the server side NodeJS library, see https://github.com/cloudinary/cloudinary_npm
|
||
|
||
1. Install the files using:
|
||
|
||
```shell
|
||
npm install cloudinary-core
|
||
```
|
||
1. Include the javascript file in your HTML. For Example:
|
||
|
||
```html
|
||
<script src="node_modules/lodash/lodash.js" type="text/javascript"></script>
|
||
<script src="node_modules/cloudinary-core/cloudinary-core.js" type="text/javascript"></script>
|
||
```
|
||
|
||
See comment above regarding the shrinkwrap version.
|
||
|
||
For the server side NPM library, please refer to https://github.com/cloudinary/cloudinary_npm.
|
||
|
||
## Setup
|
||
|
||
In order to properly use this library you have to provide it with a few configuration parameters:
|
||
|
||
Required:
|
||
|
||
* `cloud_name` - The cloudinary cloud name associated with your Cloudinary account.
|
||
|
||
Optional:
|
||
|
||
* `private_cdn`, `secure_distribution`, `cname`, `cdn_subdomain` - Please refer to [Cloudinary Documentation](http://cloudinary.com/documentation/rails_additional_topics#configuration_options) for information on these parameters.
|
||
|
||
To set these configuration parameters use the `Cloudinary::config` function (see below).
|
||
|
||
## Usage
|
||
|
||
The following blog post details the process of setting up a jQuery based file upload.
|
||
http://cloudinary.com/blog/direct_image_uploads_from_the_browser_to_the_cloud_with_jquery
|
||
|
||
The Cloudinary Documentation can be found at:
|
||
http://cloudinary.com/documentation
|
||
|
||
### Cloudinary JavaScript library
|
||
|
||
The Core Cloudinary JavaScript library provides several classes, defined under the "`cloudinary`" domain. The reference documentation is located at https://cloudinary.github.io/pkg-cloudinary-core
|
||
|
||
The Cloudinary JavaScript library provides several classes, defined under the "`cloudinary`" domain.
|
||
|
||
#### Configuration
|
||
|
||
Start by instantiating a new Cloudinary class:
|
||
|
||
##### Explicitly
|
||
|
||
```javascript
|
||
var cl = cloudinary.Cloudinary.new( { cloud_name: "demo"});
|
||
```
|
||
|
||
##### Using the config function
|
||
|
||
```javascript
|
||
|
||
// Using the config function
|
||
var cl = cloudinary.Cloudinary.new();
|
||
cl.config( "cloud_name", "demo");
|
||
```
|
||
|
||
##### From meta tags in the current HTML document
|
||
|
||
When using the library in a browser environment, you can use meta tags to define the configuration options.
|
||
|
||
The `init()` function is a convenience function that invokes both `fromDocument()` and `fromEnvironment()`.
|
||
|
||
|
||
For example, add the following to the header tag:
|
||
```html
|
||
<meta name="cloudinary_cloud_name" content="demo">
|
||
```
|
||
|
||
In your JavaScript source, invoke `fromDocument()`:
|
||
```javascript
|
||
var cl = cloudinary.Cloudinary.new();
|
||
cl.fromDocument();
|
||
// or
|
||
cl.init();
|
||
```
|
||
|
||
##### From environment variables
|
||
|
||
When using the library in a backend environment such as NodeJS, you can use an environment variable to define the configuration options.
|
||
|
||
Set the environment variable, for example:
|
||
```shell
|
||
export CLOUDINARY_URL=cloudinary://demo
|
||
```
|
||
In your JavaScript source, invoke `fromEnvironment()`:
|
||
```javascript
|
||
var cl = cloudinary.Cloudinary.new();
|
||
cl.fromEnvironment();
|
||
// or
|
||
cl.init();
|
||
|
||
```
|
||
|
||
#### URL generation
|
||
|
||
```javascript
|
||
cl.url("sample")
|
||
// "http://res.cloudinary.com/demo/image/upload/sample"
|
||
cl.url( "sample", { width: 100, crop: "fit"})
|
||
// "http://res.cloudinary.com/demo/image/upload/c_fit,w_100/sample"
|
||
|
||
```
|
||
|
||
#### HTML tag generation
|
||
|
||
You can generate HTML tags in several ways:
|
||
|
||
`Cloudinary::image()` generates a DOM tag, and prepares it for responsive functionality. This is the same functionality as `$.cloudinary.image()` in the Cloudinary jQuery library.
|
||
|
||
```javascript
|
||
cl.image("sample")
|
||
```
|
||
produces:
|
||
```html
|
||
<img src="http://res.cloudinary.com/demo/image/upload/sample" data-src-cache="http://res.cloudinary.com/demo/image/upload/sample">
|
||
```
|
||
|
||
You can generate an image Tag using the `imageTag` function:
|
||
|
||
```javascript
|
||
var tag = cl.imageTag("sample");
|
||
tag.toHtml();
|
||
```
|
||
which produces:
|
||
```html
|
||
<img src="http://res.cloudinary.com/demo/image/upload/sample">
|
||
```
|
||
and:
|
||
```javascript
|
||
tag.transformation().crop("fit").width(100).toHtml();
|
||
```
|
||
which produces:
|
||
```html
|
||
<img src="http://res.cloudinary.com/demo/image/upload/c_fit,w_100/sample">
|
||
```
|
||
|
||
You can also use `ImageTag` independently:
|
||
|
||
```javascript
|
||
var tag = cloudinary.ImageTag.new( "sample", { cloud_name: "some_other_cloud" });
|
||
tag.toHtml();
|
||
```
|
||
which produces:
|
||
```html
|
||
<img src="http://res.cloudinary.com/some_other_cloud/image/upload/sample">
|
||
```
|
||
|
||
|
||
#### Transformation
|
||
|
||
In addition to using a plain object to define transformations or using the builder methods (both described above), you can define transformations by using the Transformation class:
|
||
|
||
```javascript
|
||
var tr = cloudinary.Transformation.new();
|
||
tr.crop("fit").width(100);
|
||
tr.serialize()
|
||
// "c_fit,w_100"
|
||
```
|
||
|
||
You can also chain transformations together:
|
||
|
||
```javascript
|
||
var tr = cloudinary.Transformation.new();
|
||
tr.width(10).crop('fit').chain().angle(15).serialize()
|
||
// "c_fit,w_10/a_15"
|
||
```
|
||
|
||
 **See [our documentation](http://cloudinary.com/documentation/jquery_image_manipulation) for more information about displaying and transforming images using jQuery**.
|
||
|
||
### Other Cloudinary JavaScript libraries
|
||
|
||
#### jQuery plugin
|
||
If you are using jQuery, you can take advantage of the Cloudinary jQuery plugin at [https://github.com/cloudinary/pkg-cloudinary-jquery](https://github.com/cloudinary/pkg-cloudinary-jquery).
|
||
|
||
#### jQuery File upload
|
||
The Cloudinary jQuery File Upload library extends the Cloudinary jQuery plugin with support for the [Blueimp jQuery File Upload library](https://blueimp.github.io/jQuery-File-Upload/).
|
||
The library can be found at [https://github.com/cloudinary/pkg-cloudinary-jquery-file-upload](https://github.com/cloudinary/pkg-cloudinary-jquery-file-upload).
|
||
|
||
## Additional resources
|
||
|
||
Additional resources are available at:
|
||
|
||
* [Website](http://cloudinary.com)
|
||
* [Documentation](http://cloudinary.com/documentation)
|
||
* [Knowledge Base](http://support.cloudinary.com/forums)
|
||
* [Documentation for jQuery integration](http://cloudinary.com/documentation/jquery_integration)
|
||
* [jQuery image upload documentation](http://cloudinary.com/documentation/jquery_image_upload)
|
||
* [jQuery image manipulation documentation](http://cloudinary.com/documentation/jquery_image_manipulation)
|
||
* [Image transformations documentation](http://cloudinary.com/documentation/image_transformations)
|
||
|
||
## Support
|
||
|
||
You can [open an issue through GitHub](https://github.com/cloudinary/cloudinary_js/issues).
|
||
|
||
Contact us at [http://cloudinary.com/contact](http://cloudinary.com/contact).
|
||
|
||
Stay tuned for updates, tips and tutorials: [Blog](http://cloudinary.com/blog), [Twitter](https://twitter.com/cloudinary), [Facebook](http://www.facebook.com/Cloudinary).
|
||
|
||
|
||
## License
|
||
|
||
Released under the MIT license.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- cloudinary@1.25.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
[](https://travis-ci.org/cloudinary/cloudinary_npm)
|
||
|
||
Cloudinary
|
||
==========
|
||
|
||
Cloudinary is a cloud service that offers a solution to a web application's entire image management pipeline.
|
||
|
||
Easily upload images to the cloud. Automatically perform smart image resizing, cropping and conversion without installing any complex software. Integrate Facebook or Twitter profile image extraction in a snap, in any dimension and style to match your website’s graphics requirements. Images are seamlessly delivered through a fast CDN, and much much more.
|
||
|
||
Cloudinary offers comprehensive APIs and administration capabilities and is easy to integrate with any web application, existing or new.
|
||
|
||
Cloudinary provides URL and HTTP based APIs that can be easily integrated with any Web development framework.
|
||
|
||
For Node.js, Cloudinary provides an extension for simplifying the integration even further.
|
||
|
||
## Getting started guide
|
||
 **Take a look at our [Getting started guide for Node.js](https://cloudinary.com/documentation/node_integration#node_js_getting_started_guide)**.
|
||
|
||
|
||
## Setup ######################################################################
|
||
|
||
``` npm install cloudinary ```
|
||
|
||
## Try it right away
|
||
|
||
Sign up for a [free account](https://cloudinary.com/users/register/free) so you can try out image transformations and seamless image delivery through CDN.
|
||
|
||
*Note: Replace `demo` in all the following examples with your Cloudinary's `cloud name`.*
|
||
|
||
Accessing an uploaded image with the `sample` public ID through a CDN:
|
||
|
||
http://res.cloudinary.com/demo/image/upload/sample.jpg
|
||
|
||
|
||
|
||
Generating a 150x100 version of the `sample` image and downloading it through a CDN:
|
||
|
||
http://res.cloudinary.com/demo/image/upload/w_150,h_100,c_fill/sample.jpg
|
||
|
||
|
||
|
||
Converting to a 150x100 PNG with rounded corners of 20 pixels:
|
||
|
||
http://res.cloudinary.com/demo/image/upload/w_150,h_100,c_fill,r_20/sample.png
|
||
|
||
|
||
|
||
For plenty more transformation options, see our [image transformations documentation](http://cloudinary.com/documentation/image_transformations).
|
||
|
||
Generating a 120x90 thumbnail based on automatic face detection of the Facebook profile picture of Bill Clinton:
|
||
|
||
http://res.cloudinary.com/demo/image/facebook/c_thumb,g_face,h_90,w_120/billclinton.jpg
|
||
|
||
|
||
|
||
For more details, see our documentation for embedding [Facebook](https://cloudinary.com/documentation/facebook_profile_pictures) and [Twitter](https://cloudinary.com/documentation/twitter_profile_pictures) profile pictures.
|
||
|
||
|
||
## Usage
|
||
|
||
### Configuration
|
||
|
||
Each request for building a URL of a remote cloud resource must have the `cloud_name` parameter set.
|
||
Each request to our secure APIs (e.g., image uploads, eager sprite generation) must have the `api_key` and `api_secret` parameters set. See [API, URLs and access identifiers](https://cloudinary.com/documentation/solution_overview#account_and_api_setup) for more details.
|
||
|
||
Setting the `cloud_name`, `api_key` and `api_secret` parameters can be done either directly in each call to a Cloudinary method, by calling the cloudinary.config(), or by using the CLOUDINARY_URL environment variable.
|
||
|
||
### Require the Cloudinary library
|
||
|
||
```js
|
||
var cloudinary = require('cloudinary').v2
|
||
```
|
||
|
||
### Overriding the request agent
|
||
To override the request agent pass the agent into any method that makes a
|
||
request and it will be used instead of the normal https agent. e.g
|
||
|
||
```js
|
||
cloudinary.uploader.upload_stream(
|
||
{ agent: myAgent },
|
||
function(error, result) { console.log(result); }
|
||
);
|
||
|
||
```
|
||
|
||
### Embedding and transforming images
|
||
|
||
Any image uploaded to Cloudinary can be transformed and embedded using powerful view helper methods:
|
||
|
||
The following example generates the url for accessing an uploaded `sample` image while transforming it to fill a 100x150 rectangle:
|
||
|
||
```js
|
||
cloudinary.url("sample.jpg", {width: 100, height: 150, crop: "fill"})
|
||
```
|
||
|
||
Another example, emedding a smaller version of an uploaded image while generating a 90x90 face detection based thumbnail:
|
||
|
||
```js
|
||
cloudinary.url("woman.jpg", {width: 90, height: 90, crop: "thumb", gravity: "face"});
|
||
```
|
||
|
||
You can provide either a Facebook name or a numeric ID of a Facebook profile or a fan page.
|
||
|
||
Embedding a Facebook profile to match your graphic design is very simple:
|
||
|
||
```js
|
||
cloudinary.url("billclinton.jpg", {width: 90, height: 130, type: "facebook", crop: "fill", gravity: "north_west"});
|
||
```
|
||
|
||
Same goes for Twitter:
|
||
|
||
```js
|
||
cloudinary.url("billclinton.jpg", {type: "twitter_name"});
|
||
```
|
||
|
||
 **See [our documentation](https://cloudinary.com/documentation/node_image_manipulation) for more information about displaying and transforming images in Node.js**.
|
||
|
||
### Upload
|
||
|
||
Assuming you have your Cloudinary configuration parameters defined (`cloud_name`, `api_key`, `api_secret`), uploading to Cloudinary is very simple.
|
||
|
||
The following example uploads a local JPG to the cloud:
|
||
|
||
```js
|
||
var cloudinary = require('cloudinary').v2;
|
||
cloudinary.uploader.upload("my_picture.jpg", function(error, result) { console.log(result) });
|
||
```
|
||
|
||
Below is an example of an upload's result:
|
||
|
||
```json
|
||
{
|
||
"public_id": "4srvcynxrf5j87niqcx6w",
|
||
"version": 1340625837,
|
||
"signature": "01234567890abcdef01234567890abcdef012345",
|
||
"width": 200,
|
||
"height": 200,
|
||
"format": "jpg",
|
||
"resource_type": "image",
|
||
"url": "http://res.cloudinary.com/demo/image/upload/v1340625837/4srvcynxrf5j87niqcx6w.jpg",
|
||
"secure_url": "https://res.cloudinary.com/demo/image/upload/v1340625837/4srvcynxrf5j87niqcx6w.jpg"
|
||
}
|
||
```
|
||
|
||
The uploaded image is assigned a randomly generated public ID. The image is immediately available for download through a CDN:
|
||
|
||
```js
|
||
cloudinary.url("abcfrmo8zul1mafopawefg.jpg");
|
||
|
||
// http://res.cloudinary.com/demo/image/upload/abcfrmo8zul1mafopawefg.jpg
|
||
```
|
||
You can also specify your own public ID:
|
||
|
||
```js
|
||
cloudinary.uploader.upload(
|
||
"http://www.example.com/image.jpg",
|
||
{public_id: 'sample_remote'},
|
||
function(error, result) {
|
||
console.log(result)
|
||
}
|
||
);
|
||
|
||
cloudinary.url("sample_remote.jpg")
|
||
|
||
// http://res.cloudinary.com/demo/image/upload/sample_remote.jpg
|
||
|
||
```
|
||
|
||
 **See [our documentation](https://cloudinary.com/documentation/node_image_upload) for plenty more options of uploading to the cloud from your Node.js code or directly from the browser**.
|
||
|
||
### cloudinary.upload_stream
|
||
|
||
You can use cloudinary.upload_stream to write to the uploader as a stream:
|
||
|
||
```js
|
||
var fs = require('fs');
|
||
var stream = cloudinary.uploader.upload_stream(function(error, result) { console.log(result); });
|
||
var file_reader = fs.createReadStream('my_picture.jpg', {encoding: 'binary'}).on('data', stream.write).on('end', stream.end);
|
||
```
|
||
|
||
#### Version 1.1 upload_stream change notes
|
||
The `upload_stream` method was modified to return a `Transform` stream object, we advise to change the `on('data')` and `on('end')` to pipe API:
|
||
|
||
```js
|
||
var file_reader = fs.createReadStream('my_picture.jpg').pipe(stream);
|
||
|
||
```
|
||
if you still need to use event chanining, you can wrap `stream.write` and `stream.end` with wrapper functions
|
||
|
||
```js
|
||
var file_reader = fs.createReadStream('my_picture.jpg', {encoding: 'binary'})
|
||
.on('data', function(data){stream.write(data)})
|
||
.on('end', function(){stream.end()});
|
||
```
|
||
### cloudinary.image
|
||
|
||
Returns an html image tag pointing to Cloudinary.
|
||
|
||
Usage:
|
||
|
||
```js
|
||
cloudinary.image("sample", {format: "png", width: 100, height: 100, crop: "fill"})
|
||
|
||
// <img src='http://res.cloudinary.com/demo/image/upload/c_fill,h_100,w_100/sample.png' height='100' width='100'/>
|
||
```
|
||
|
||
### Typescript
|
||
|
||
🎉New 🎉TypeScript support was just added. Check out the [declaration file](https://github.com/cloudinary/cloudinary_npm/blob/master/types/index.d.ts).
|
||
|
||
### Samples
|
||
|
||
You can find our simple and ready-to-use samples projects, along with documentation in the [samples folder](https://github.com/cloudinary/cloudinary_npm/tree/master/samples).
|
||
Please consult with the [README file](https://github.com/cloudinary/cloudinary_npm/blob/master/samples/README.md), for usage and explanations.
|
||
|
||
|
||
## Additional resources ##########################################################
|
||
|
||
Additional resources are available at:
|
||
|
||
* [Website](https://cloudinary.com)
|
||
* [Interactive demo](https://demo.cloudinary.com/default)
|
||
* [Documentation](https://cloudinary.com/documentation)
|
||
* [Knowledge Base](https://support.cloudinary.com/hc/en-us)
|
||
* [Documentation for Node.js integration](https://cloudinary.com/documentation/node_integration)
|
||
* [Node.js image upload documentation](https://cloudinary.com/documentation/node_image_upload)
|
||
* [Node.js image manipulation documentation](https://cloudinary.com/documentation/node_image_manipulation)
|
||
* [Image transformations documentation](https://cloudinary.com/documentation/image_transformations)
|
||
|
||
## Run test
|
||
|
||
```
|
||
npm run test
|
||
```
|
||
|
||
## Node support
|
||
This SDK requires node >= 8.
|
||
|
||
## Support
|
||
|
||
You can [open an issue through GitHub](https://github.com/cloudinary/cloudinary_npm/issues).
|
||
|
||
Contact us [https://cloudinary.com/contact](https://cloudinary.com/contact)
|
||
|
||
Stay tuned for updates, tips and tutorials: [Blog](https://cloudinary.com/blog), [Twitter](https://twitter.com/cloudinary), [Facebook](https://www.facebook.com/Cloudinary).
|
||
|
||
## Join the Community ##########################################################
|
||
|
||
Impact the product, hear updates, test drive new features and more! Join [here](https://www.facebook.com/groups/CloudinaryCommunity).
|
||
|
||
|
||
## License #######################################################################
|
||
|
||
Released under the MIT license.
|
||
|
||
Test resources include the video [Cloud Book Study](https://vimeo.com/27172301)
|
||
which was created by [Heidi Neilson](https://vimeo.com/heidineilson)
|
||
and is distributed under the Creative commons - attribution license (CC BY 3.0)
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- co@4.6.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- color-convert@1.9.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2011-2016 Heather Arthur <fayearthur@gmail.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- color-name@1.1.3
|
||
- color-name@1.1.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
Copyright (c) 2015 Dmitry Ivanov
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- color-string@1.5.5
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2011 Heather Arthur <fayearthur@gmail.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- color@3.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2012 Heather Arthur
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- colors@1.4.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Original Library
|
||
- Copyright (c) Marak Squires
|
||
|
||
Additional Functionality
|
||
- 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- combined-stream@1.0.8
|
||
- delayed-stream@1.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2011 Debuggable Limited <felix@debuggable.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- component-emitter@1.3.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014 Component contributors <dev@component.io>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- compressible@2.0.18
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Jonathan Ong <me@jongleberry.com>
|
||
Copyright (c) 2014 Jeremiah Senkpiel <fishrock123@rocketmail.com>
|
||
Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- concat-stream@1.6.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License
|
||
|
||
Copyright (c) 2013 Max Ogden
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- configstore@5.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
BSD 2-Clause License
|
||
|
||
Copyright (c) Google
|
||
All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are met:
|
||
|
||
* Redistributions of source code must retain the above copyright notice, this
|
||
list of conditions and the following disclaimer.
|
||
|
||
* Redistributions in binary form must reproduce the above copyright notice,
|
||
this list of conditions and the following disclaimer in the documentation
|
||
and/or other materials provided with the distribution.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- content-disposition@0.5.3
|
||
- depd@1.1.2
|
||
- forwarded@0.1.2
|
||
- vary@1.1.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014-2017 Douglas Christopher Wilson
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- content-type@1.0.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2015 Douglas Christopher Wilson
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- cookie-signature@1.0.6
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# cookie-signature
|
||
|
||
Sign and unsign cookies.
|
||
|
||
## Example
|
||
|
||
```js
|
||
var cookie = require('cookie-signature');
|
||
|
||
var val = cookie.sign('hello', 'tobiiscool');
|
||
val.should.equal('hello.DGDUkGlIkCzPz+C0B064FNgHdEjox7ch8tOBGslZ5QI');
|
||
|
||
var val = cookie.sign('hello', 'tobiiscool');
|
||
cookie.unsign(val, 'tobiiscool').should.equal('hello');
|
||
cookie.unsign(val, 'luna').should.be.false;
|
||
```
|
||
|
||
## License
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2012 LearnBoost <tj@learnboost.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- cookie@0.4.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2012-2014 Roman Shtylman <shtylman@gmail.com>
|
||
Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- cookiejar@2.1.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
Copyright (c) 2013 Bradley Meck
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- core-js@3.6.5
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2014-2020 Denis Pushkarev
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- core-util-is@1.0.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright Node.js contributors. All rights reserved.
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- cors@2.8.5
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Troy Goode <troygoode@gmail.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- cross-fetch@3.1.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2017 Leonardo Quixadá
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- csrf@3.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
|
||
Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- css-select@1.2.0
|
||
- css-what@2.1.3
|
||
- domelementtype@1.3.1
|
||
- domhandler@2.4.2
|
||
- domutils@1.5.1
|
||
- entities@1.1.2
|
||
- nth-check@1.0.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) Felix Böhm
|
||
All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||
|
||
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||
|
||
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||
|
||
THIS IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS,
|
||
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- cssom@0.4.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) Nikita Vasilyev
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- data-uri-to-buffer@1.2.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
data-uri-to-buffer
|
||
==================
|
||
### Generate a Buffer instance from a [Data URI][rfc] string
|
||
[](https://travis-ci.org/TooTallNate/node-data-uri-to-buffer)
|
||
|
||
This module accepts a ["data" URI][rfc] String of data, and returns a
|
||
node.js `Buffer` instance with the decoded data.
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install data-uri-to-buffer
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
``` js
|
||
var dataUriToBuffer = require('data-uri-to-buffer');
|
||
|
||
// plain-text data is supported
|
||
var uri = 'data:,Hello%2C%20World!';
|
||
var decoded = dataUriToBuffer(uri);
|
||
console.log(decoded.toString());
|
||
// 'Hello, World!'
|
||
|
||
// base64-encoded data is supported
|
||
uri = 'data:text/plain;base64,SGVsbG8sIFdvcmxkIQ%3D%3D';
|
||
decoded = dataUriToBuffer(uri);
|
||
console.log(decoded.toString());
|
||
// 'Hello, World!'
|
||
```
|
||
|
||
|
||
API
|
||
---
|
||
|
||
### dataUriToBuffer(String uri) → Buffer
|
||
|
||
The `type` property on the Buffer instance gets set to the Content-Type portion of
|
||
the "mediatype" portion of the "data" URI, or defaults to `"text/plain"` if not
|
||
specified.
|
||
|
||
The `charset` property on the Buffer instance gets set to the Charset portion of
|
||
the "mediatype" portion of the "data" URI, or defaults to `"US-ASCII"` if not
|
||
specified.
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
[rfc]: http://tools.ietf.org/html/rfc2397
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- data-uri-to-buffer@3.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
data-uri-to-buffer
|
||
==================
|
||
### Generate a Buffer instance from a [Data URI][rfc] string
|
||
[](https://travis-ci.org/TooTallNate/node-data-uri-to-buffer)
|
||
|
||
This module accepts a ["data" URI][rfc] String of data, and returns a
|
||
node.js `Buffer` instance with the decoded data.
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install data-uri-to-buffer
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
``` js
|
||
var dataUriToBuffer = require('data-uri-to-buffer');
|
||
|
||
// plain-text data is supported
|
||
var uri = 'data:,Hello%2C%20World!';
|
||
var decoded = dataUriToBuffer(uri);
|
||
console.log(decoded.toString());
|
||
// 'Hello, World!'
|
||
|
||
// base64-encoded data is supported
|
||
uri = 'data:text/plain;base64,SGVsbG8sIFdvcmxkIQ%3D%3D';
|
||
decoded = dataUriToBuffer(uri);
|
||
console.log(decoded.toString());
|
||
// 'Hello, World!'
|
||
```
|
||
|
||
|
||
API
|
||
---
|
||
|
||
### dataUriToBuffer(String uri) → Buffer
|
||
|
||
The `type` property on the Buffer instance gets set to the main type portion of
|
||
the "mediatype" portion of the "data" URI, or defaults to `"text/plain"` if not
|
||
specified.
|
||
|
||
The `typeFull` property on the Buffer instance gets set to the entire
|
||
"mediatype" portion of the "data" URI (including all parameters), or defaults
|
||
to `"text/plain;charset=US-ASCII"` if not specified.
|
||
|
||
The `charset` property on the Buffer instance gets set to the Charset portion of
|
||
the "mediatype" portion of the "data" URI, or defaults to `"US-ASCII"` if the
|
||
entire type is not specified, or defaults to `""` otherwise.
|
||
|
||
*Note*: If the only the main type is specified but not the charset, e.g.
|
||
`"data:text/plain,abc"`, the charset is set to the empty string. The spec only
|
||
defaults to US-ASCII as charset if the entire type is not specified.
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
[rfc]: http://tools.ietf.org/html/rfc2397
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- date-and-time@0.14.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 KNOWLEDGECODE
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- dayjs@1.10.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2018-present, iamkun
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- debug@2.6.9
|
||
- debug@3.1.0
|
||
- debug@3.2.7
|
||
- debug@4.3.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- decode-uri-component@0.2.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) Sam Verschueren <sam.verschueren@gmail.com> (github.com/SamVerschueren)
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- deep-is@0.1.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2012, 2013 Thorsten Lorenz <thlorenz@gmx.de>
|
||
Copyright (c) 2012 James Halliday <mail@substack.net>
|
||
Copyright (c) 2009 Thomas Robinson <280north.com>
|
||
|
||
This software is released under the MIT license:
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- degenerator@1.0.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
degenerator
|
||
===========
|
||
### Turns sync functions into async generator functions
|
||
[](https://travis-ci.org/TooTallNate/node-degenerator)
|
||
|
||
Sometimes you need to write sync looking code that's really async under the hood.
|
||
This module takes a String to one or more synchronous JavaScript functions, and
|
||
returns a new String that with those JS functions transpiled into ES6 Generator
|
||
Functions.
|
||
|
||
So this:
|
||
|
||
``` js
|
||
function foo () {
|
||
return a('bar') || b();
|
||
}
|
||
```
|
||
|
||
Gets compiled into:
|
||
|
||
``` js
|
||
function* foo() {
|
||
return (yield a('bar')) || (yield b());
|
||
}
|
||
```
|
||
|
||
From there, you can provide asynchronous thunk-based or Generator-based
|
||
implementations for the `a()` and `b()` functions, in conjunction with any
|
||
Generator-based flow control library to execute the contents of the
|
||
function asynchronously.
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install degenerator
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
You must explicitly specify the names of the functions that should be
|
||
"asyncified". So say we wanted to expose a `get(url)` function that did
|
||
and HTTP request and returned the response body.
|
||
|
||
The user has provided us with this implementation:
|
||
|
||
``` js
|
||
function myFn () {
|
||
var one = get('https://google.com');
|
||
var two = get('http://nodejs.org');
|
||
var three = JSON.parse(get('http://jsonip.org'));
|
||
return [one, two, three];
|
||
}
|
||
```
|
||
|
||
Now we can compile this into an asyncronous generator function, implement the
|
||
async `get()` function, and finally evaluate it into a real JavaScript function
|
||
instance with the `vm` module:
|
||
|
||
|
||
``` js
|
||
var co = require('co');
|
||
var vm = require('vm');
|
||
var degenerator = require('degenerator');
|
||
|
||
// the `get()` function is thunk-based (error handling omitted for brevity)
|
||
function get (endpoint) {
|
||
return function (fn) {
|
||
var mod = 0 == endpoint.indexOf('https:') ? require('https') : require('http');
|
||
var req = mod.get(endpoint);
|
||
req.on('response', function (res) {
|
||
var data = '';
|
||
res.setEncoding('utf8');
|
||
res.on('data', function (b) { data += b; });
|
||
res.on('end', function () {
|
||
fn(null, data);
|
||
});
|
||
});
|
||
};
|
||
}
|
||
|
||
// convert the JavaScript string provided from the user (assumed to be `str` var)
|
||
str = degenerator(str, [ 'get' ]);
|
||
|
||
// at this stage, you could use a transpiler like `facebook/regenerator`
|
||
// here if desired.
|
||
|
||
// turn the JS String into a real GeneratorFunction instance
|
||
var genFn = vm.runInNewContext('(' + str + ')', { get: get });
|
||
|
||
// use a generator-based flow control library (`visionmedia/co`, `jmar777/suspend`,
|
||
// etc.) to create an async function from the generator function.
|
||
|
||
var asnycFn = co(genFn);
|
||
|
||
// NOW USE IT!!!
|
||
asyncFn(function (err, res) {
|
||
// ...
|
||
});
|
||
```
|
||
|
||
|
||
API
|
||
---
|
||
|
||
### degenerator(String jsStr, Array functionNames) → String
|
||
|
||
Returns a "degeneratorified" JavaScript string, with ES6 Generator
|
||
functions transplanted.
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- degenerator@2.2.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
degenerator
|
||
===========
|
||
### Compiles sync functions into async functions
|
||
[](https://github.com/TooTallNate/node-degenerator/actions?workflow=Node+CI)
|
||
|
||
Sometimes you need to write sync looking code that's really async under the hood.
|
||
This module takes a String to one or more synchronous JavaScript functions, and
|
||
returns a new String that with those JS functions transpiled into `async`
|
||
functions.
|
||
|
||
So this:
|
||
|
||
```js
|
||
function foo() {
|
||
return a('bar') || b();
|
||
}
|
||
```
|
||
|
||
Gets compiled into:
|
||
|
||
```js
|
||
async function foo() {
|
||
return await a('bar') || await b();
|
||
}
|
||
```
|
||
|
||
With the compiled output code, you can evaluate the code using the `vm` module
|
||
in Node.js, or save the code to a file and require it, or whatever.
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
```bash
|
||
$ npm install degenerator
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
You must explicitly specify the names of the functions that should be
|
||
"asyncified". So say we wanted to expose a `get(url)` function that did
|
||
and HTTP request and returned the response body.
|
||
|
||
The user has provided us with this implementation:
|
||
|
||
``` js
|
||
function myFn() {
|
||
const one = get('https://google.com');
|
||
const two = get('http://nodejs.org');
|
||
const three = JSON.parse(get('http://jsonip.org'));
|
||
return [one, two, three];
|
||
}
|
||
```
|
||
|
||
Now we can compile this into an asyncronous function, implement the
|
||
async `get()` function, and finally evaluate it into a real JavaScript function
|
||
instance with the `vm` module:
|
||
|
||
|
||
```typescript
|
||
import vm from 'vm';
|
||
import degenerator from 'degenerator';
|
||
|
||
// The `get()` function is Promise-based (error handling omitted for brevity)
|
||
function get(endpoint: string) {
|
||
return new Promise((resolve, reject) => {
|
||
var mod = 0 == endpoint.indexOf('https:') ? require('https') : require('http');
|
||
var req = mod.get(endpoint);
|
||
req.on('response', function (res) {
|
||
var data = '';
|
||
res.setEncoding('utf8');
|
||
res.on('data', function (b) { data += b; });
|
||
res.on('end', function () {
|
||
resolve(data);
|
||
});
|
||
});
|
||
});
|
||
}
|
||
|
||
// Convert the JavaScript string provided from the user (assumed to be `str` var)
|
||
str = degenerator(str, [ 'get' ]);
|
||
|
||
// Turn the JS String into a real async function instance
|
||
const asyncFn = vm.runInNewContext(`(${str})`, { get });
|
||
|
||
// Now we can invoke the function asynchronously
|
||
asyncFn().then((res) => {
|
||
// Do something with `res`...
|
||
});
|
||
```
|
||
|
||
|
||
API
|
||
---
|
||
|
||
### degenerator(code: string, names: Array<string|RegExp>, options?: DegeneratorOptions): String
|
||
|
||
Returns a "degeneratorified" JavaScript string, with `async`/`await` transplanted.
|
||
|
||
#### DegeneratorOptions
|
||
|
||
An options object _may_ be passed in as the third parameter, with the following
|
||
values:
|
||
|
||
* `output` - string - May be `"async"` or `"generator"`, defaults to `"async"`.
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- destroy@1.0.4
|
||
- ee-first@1.1.1
|
||
- mime-db@1.46.0
|
||
- rndm@1.2.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014 Jonathan Ong me@jongleberry.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- dicer@0.3.0
|
||
- ftp@0.3.10
|
||
- streamsearch@0.1.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright Brian White. All rights reserved.
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- dinero.js@1.8.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2018 Sarah Dayan
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- dom-serializer@0.1.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
License
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014 The cheeriojs 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- dotenv@8.2.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2015, Scott Motte
|
||
All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are met:
|
||
|
||
* Redistributions of source code must retain the above copyright notice, this
|
||
list of conditions and the following disclaimer.
|
||
|
||
* Redistributions in binary form must reproduce the above copyright notice,
|
||
this list of conditions and the following disclaimer in the documentation
|
||
and/or other materials provided with the distribution.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- duplexify@4.1.1
|
||
- end-of-stream@1.4.4
|
||
- pump@3.0.0
|
||
- pumpify@2.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014 Mathias Buus
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- ecdsa-sig-formatter@1.0.11
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
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 2015 D2L Corporation
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- encodeurl@1.0.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2016 Douglas Christopher Wilson
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- ent@2.2.0
|
||
- is-typedarray@1.0.0
|
||
- snakeize@0.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
This software is released under the MIT license:
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- es6-promise@4.2.8
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2014 Yehuda Katz, Tom Dale, Stefan Penner and 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- es6-promisify@5.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
[](https://travis-ci.org/digitaldesignlabs/es6-promisify)
|
||
|
||
# es6-promisify
|
||
|
||
Converts callback-based functions to Promise-based functions.
|
||
|
||
## Install
|
||
|
||
Install with [npm](https://npmjs.org/package/es6-promisify)
|
||
|
||
```bash
|
||
npm install --save es6-promisify
|
||
```
|
||
|
||
## Example
|
||
|
||
```js
|
||
"use strict";
|
||
|
||
// Declare variables
|
||
const promisify = require("es6-promisify");
|
||
const fs = require("fs");
|
||
|
||
// Convert the stat function
|
||
const stat = promisify(fs.stat);
|
||
|
||
// Now usable as a promise!
|
||
stat("example.txt").then(function (stats) {
|
||
console.log("Got stats", stats);
|
||
}).catch(function (err) {
|
||
console.error("Yikes!", err);
|
||
});
|
||
```
|
||
|
||
## Promisify methods
|
||
```js
|
||
"use strict";
|
||
|
||
// Declare variables
|
||
const promisify = require("es6-promisify");
|
||
const redis = require("redis").createClient(6379, "localhost");
|
||
|
||
// Create a promise-based version of send_command
|
||
const client = promisify(redis.send_command, redis);
|
||
|
||
// Send commands to redis and get a promise back
|
||
client("ping").then(function (pong) {
|
||
console.log("Got", pong);
|
||
}).catch(function (err) {
|
||
console.error("Unexpected error", err);
|
||
}).then(function () {
|
||
redis.quit();
|
||
});
|
||
```
|
||
|
||
## Handle callback multiple arguments
|
||
```js
|
||
"use strict";
|
||
|
||
// Declare functions
|
||
function test(cb) {
|
||
return cb(undefined, 1, 2, 3);
|
||
}
|
||
|
||
// Declare variables
|
||
const promisify = require("es6-promisify");
|
||
|
||
// Create promise-based version of test
|
||
const single = promisify(test);
|
||
const multi = promisify(test, {multiArgs: true});
|
||
|
||
// Discards additional arguments
|
||
single().then(function (result) {
|
||
console.log(result); // 1
|
||
});
|
||
|
||
// Returns all arguments as an array
|
||
multi().then(function (result) {
|
||
console.log(result); // [1, 2, 3]
|
||
});
|
||
```
|
||
|
||
### Tests
|
||
Test with nodeunit
|
||
```bash
|
||
$ npm test
|
||
```
|
||
|
||
Published under the [MIT License](http://opensource.org/licenses/MIT).
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- escape-html@1.0.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2012-2013 TJ Holowaychuk
|
||
Copyright (c) 2015 Andreas Lubbe
|
||
Copyright (c) 2015 Tiancheng "Timothy" Gu
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- escodegen@1.14.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (C) 2012 Yusuke Suzuki (twitter: @Constellation) and other contributors.
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are met:
|
||
|
||
* Redistributions of source code must retain the above copyright
|
||
notice, this list of conditions and the following disclaimer.
|
||
* Redistributions in binary form must reproduce the above copyright
|
||
notice, this list of conditions and the following disclaimer in the
|
||
documentation and/or other materials provided with the distribution.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||
ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
|
||
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
||
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- esprima@3.1.3
|
||
- esprima@4.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright JS Foundation and other contributors, https://js.foundation/
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are met:
|
||
|
||
* Redistributions of source code must retain the above copyright
|
||
notice, this list of conditions and the following disclaimer.
|
||
* Redistributions in binary form must reproduce the above copyright
|
||
notice, this list of conditions and the following disclaimer in the
|
||
documentation and/or other materials provided with the distribution.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||
ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
|
||
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
||
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- estraverse@4.3.0
|
||
- esutils@2.0.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are met:
|
||
|
||
* Redistributions of source code must retain the above copyright
|
||
notice, this list of conditions and the following disclaimer.
|
||
* Redistributions in binary form must reproduce the above copyright
|
||
notice, this list of conditions and the following disclaimer in the
|
||
documentation and/or other materials provided with the distribution.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||
ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
|
||
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
||
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- etag@1.8.1
|
||
- proxy-addr@2.0.6
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014-2016 Douglas Christopher Wilson
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- event-target-shim@5.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 Toru Nagashima
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- events@1.1.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT
|
||
|
||
Copyright Joyent, Inc. and other Node 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- express@4.17.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2009-2014 TJ Holowaychuk <tj@vision-media.ca>
|
||
Copyright (c) 2013-2014 Roman Shtylman <shtylman+expressjs@gmail.com>
|
||
Copyright (c) 2014-2015 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- extend@3.0.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014 Stefan Thomas
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- extract-files@9.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# extract-files
|
||
|
||
[](https://npm.im/extract-files) [](https://github.com/jaydenseric/extract-files/actions)
|
||
|
||
Clones a value, recursively extracting [`File`](https://developer.mozilla.org/docs/web/api/file), [`Blob`](https://developer.mozilla.org/docs/web/api/blob) and [`ReactNativeFile`](#class-reactnativefile) instances with their [object paths](#type-objectpath), replacing them with `null`. [`FileList`](https://developer.mozilla.org/docs/web/api/filelist) instances are treated as [`File`](https://developer.mozilla.org/docs/web/api/file) instance arrays.
|
||
|
||
Used by [GraphQL multipart request spec client implementations](https://github.com/jaydenseric/graphql-multipart-request-spec#implementations) such as [`graphql-react`](https://npm.im/graphql-react) and [`apollo-upload-client`](https://npm.im/apollo-upload-client).
|
||
|
||
## Setup
|
||
|
||
Install with [npm](https://npmjs.com/get-npm):
|
||
|
||
```shell
|
||
npm install extract-files
|
||
```
|
||
|
||
See the [`extractFiles`](#function-extractfiles) documentation to get started.
|
||
|
||
## Support
|
||
|
||
- Node.js `^10.17.0 || ^12.0.0 || >= 13.7.0`
|
||
- Browsers [`> 0.5%, not OperaMini all, not dead`](https://browserl.ist/?q=%3E+0.5%25%2C+not+OperaMini+all%2C+not+dead)
|
||
- React Native
|
||
|
||
## API
|
||
|
||
### Table of contents
|
||
|
||
- [class ReactNativeFile](#class-reactnativefile)
|
||
- [function extractFiles](#function-extractfiles)
|
||
- [function isExtractableFile](#function-isextractablefile)
|
||
- [type ExtractableFile](#type-extractablefile)
|
||
- [type ExtractableFileMatcher](#type-extractablefilematcher)
|
||
- [type ExtractFilesResult](#type-extractfilesresult)
|
||
- [type ObjectPath](#type-objectpath)
|
||
- [type ReactNativeFileSubstitute](#type-reactnativefilesubstitute)
|
||
|
||
### class ReactNativeFile
|
||
|
||
Used to mark a [React Native `File` substitute](#type-reactnativefilesubstitute) in an object tree for [`extractFiles`](#function-extractfiles). It’s too risky to assume all objects with `uri`, `type` and `name` properties are files to extract.
|
||
|
||
| Parameter | Type | Description |
|
||
| :-- | :-- | :-- |
|
||
| `file` | [ReactNativeFileSubstitute](#type-reactnativefilesubstitute) | A React Native [`File`](https://developer.mozilla.org/docs/web/api/file) substitute. |
|
||
|
||
#### Examples
|
||
|
||
_Ways to `import`._
|
||
|
||
> ```js
|
||
> import { ReactNativeFile } from 'extract-files';
|
||
> ```
|
||
>
|
||
> ```js
|
||
> import ReactNativeFile from 'extract-files/public/ReactNativeFile.js';
|
||
> ```
|
||
|
||
_Ways to `require`._
|
||
|
||
> ```js
|
||
> const { ReactNativeFile } = require('extract-files');
|
||
> ```
|
||
>
|
||
> ```js
|
||
> const ReactNativeFile = require('extract-files/public/ReactNativeFile');
|
||
> ```
|
||
|
||
_An extractable file in React Native._
|
||
|
||
> ```js
|
||
> import { ReactNativeFile } from 'extract-files';
|
||
>
|
||
> const file = new ReactNativeFile({
|
||
> uri: uriFromCameraRoll,
|
||
> name: 'a.jpg',
|
||
> type: 'image/jpeg',
|
||
> });
|
||
> ```
|
||
|
||
---
|
||
|
||
### function extractFiles
|
||
|
||
Clones a value, recursively extracting [`File`](https://developer.mozilla.org/docs/web/api/file), [`Blob`](https://developer.mozilla.org/docs/web/api/blob) and [`ReactNativeFile`](#class-reactnativefile) instances with their [object paths](#type-objectpath), replacing them with `null`. [`FileList`](https://developer.mozilla.org/docs/web/api/filelist) instances are treated as [`File`](https://developer.mozilla.org/docs/web/api/file) instance arrays.
|
||
|
||
| Parameter | Type | Description |
|
||
| :-- | :-- | :-- |
|
||
| `value` | \* | Value (typically an object tree) to extract files from. |
|
||
| `path` | [ObjectPath](#type-objectpath)? = `''` | Prefix for object paths for extracted files. |
|
||
| `isExtractableFile` | [ExtractableFileMatcher](#type-extractablefilematcher)? = [isExtractableFile](#function-isextractablefile) | The function used to identify extractable files. |
|
||
|
||
**Returns:** [ExtractFilesResult](#type-extractfilesresult) — Result.
|
||
|
||
#### Examples
|
||
|
||
_Ways to `import`._
|
||
|
||
> ```js
|
||
> import { extractFiles } from 'extract-files';
|
||
> ```
|
||
>
|
||
> ```js
|
||
> import extractFiles from 'extract-files/public/extractFiles.js';
|
||
> ```
|
||
|
||
_Ways to `require`._
|
||
|
||
> ```js
|
||
> const { extractFiles } = require('extract-files');
|
||
> ```
|
||
>
|
||
> ```js
|
||
> const extractFiles = require('extract-files/public/extractFiles');
|
||
> ```
|
||
|
||
_Extract files from an object._
|
||
|
||
> For the following:
|
||
>
|
||
> ```js
|
||
> import { extractFiles } from 'extract-files';
|
||
>
|
||
> const file1 = new File(['1'], '1.txt', { type: 'text/plain' });
|
||
> const file2 = new File(['2'], '2.txt', { type: 'text/plain' });
|
||
> const value = {
|
||
> a: file1,
|
||
> b: [file1, file2],
|
||
> };
|
||
>
|
||
> const { clone, files } = extractFiles(value, 'prefix');
|
||
> ```
|
||
>
|
||
> `value` remains the same.
|
||
>
|
||
> `clone` is:
|
||
>
|
||
> ```json
|
||
> {
|
||
> "a": null,
|
||
> "b": [null, null]
|
||
> }
|
||
> ```
|
||
>
|
||
> `files` is a [`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map) instance containing:
|
||
>
|
||
> | Key | Value |
|
||
> | :------ | :--------------------------- |
|
||
> | `file1` | `['prefix.a', 'prefix.b.0']` |
|
||
> | `file2` | `['prefix.b.1']` |
|
||
|
||
---
|
||
|
||
### function isExtractableFile
|
||
|
||
Checks if a value is an [extractable file](#type-extractablefile).
|
||
|
||
**Type:** [ExtractableFileMatcher](#type-extractablefilematcher)
|
||
|
||
| Parameter | Type | Description |
|
||
| :-------- | :--- | :-------------- |
|
||
| `value` | \* | Value to check. |
|
||
|
||
**Returns:** boolean — Is the value an [extractable file](#type-extractablefile).
|
||
|
||
#### Examples
|
||
|
||
_Ways to `import`._
|
||
|
||
> ```js
|
||
> import { isExtractableFile } from 'extract-files';
|
||
> ```
|
||
>
|
||
> ```js
|
||
> import isExtractableFile from 'extract-files/public/isExtractableFile.js';
|
||
> ```
|
||
|
||
_Ways to `require`._
|
||
|
||
> ```js
|
||
> const { isExtractableFile } = require('extract-files');
|
||
> ```
|
||
>
|
||
> ```js
|
||
> const isExtractableFile = require('extract-files/public/isExtractableFile');
|
||
> ```
|
||
|
||
---
|
||
|
||
### type ExtractableFile
|
||
|
||
An extractable file.
|
||
|
||
**Type:** File | Blob | [ReactNativeFile](#class-reactnativefile)
|
||
|
||
---
|
||
|
||
### type ExtractableFileMatcher
|
||
|
||
A function that checks if a value is an [extractable file](#type-extractablefile).
|
||
|
||
**Type:** Function
|
||
|
||
| Parameter | Type | Description |
|
||
| :-------- | :--- | :-------------- |
|
||
| `value` | \* | Value to check. |
|
||
|
||
**Returns:** boolean — Is the value an [extractable file](#type-extractablefile).
|
||
|
||
#### See
|
||
|
||
- [`isExtractableFile`](#function-isextractablefile) is the default extractable file matcher.
|
||
|
||
#### Examples
|
||
|
||
_How to check for the default exactable files, as well as a custom type of file._
|
||
|
||
> ```js
|
||
> import { isExtractableFile } from 'extract-files';
|
||
>
|
||
> const isExtractableFileEnhanced = (value) =>
|
||
> isExtractableFile(value) ||
|
||
> (typeof CustomFile !== 'undefined' && value instanceof CustomFile);
|
||
> ```
|
||
|
||
---
|
||
|
||
### type ExtractFilesResult
|
||
|
||
What [`extractFiles`](#function-extractfiles) returns.
|
||
|
||
**Type:** object
|
||
|
||
| Property | Type | Description |
|
||
| :-- | :-- | :-- |
|
||
| `clone` | \* | Clone of the original input value with files recursively replaced with `null`. |
|
||
| `files` | Map<[ExtractableFile](#type-extractablefile), Array<[ObjectPath](#type-objectpath)>> | Extracted files and their locations within the original value. |
|
||
|
||
---
|
||
|
||
### type ObjectPath
|
||
|
||
String notation for the path to a node in an object tree.
|
||
|
||
**Type:** string
|
||
|
||
#### See
|
||
|
||
- [`object-path` on npm](https://npm.im/object-path).
|
||
|
||
#### Examples
|
||
|
||
_Object path is property `a`, array index `0`, object property `b`._
|
||
|
||
> a.0.b
|
||
|
||
---
|
||
|
||
### type ReactNativeFileSubstitute
|
||
|
||
A React Native [`File`](https://developer.mozilla.org/docs/web/api/file) substitute for when using [`FormData`](https://developer.mozilla.org/docs/web/api/formdata).
|
||
|
||
**Type:** object
|
||
|
||
| Property | Type | Description |
|
||
| :------- | :------ | :----------------- |
|
||
| `uri` | string | Filesystem path. |
|
||
| `name` | string? | File name. |
|
||
| `type` | string? | File content type. |
|
||
|
||
#### See
|
||
|
||
- [React Native `FormData` polyfill source](https://github.com/facebook/react-native/blob/v0.45.1/Libraries/Network/FormData.js#L34).
|
||
|
||
#### Examples
|
||
|
||
_A camera roll file._
|
||
|
||
> ```js
|
||
> const fileSubstitute = {
|
||
> uri: uriFromCameraRoll,
|
||
> name: 'a.jpg',
|
||
> type: 'image/jpeg',
|
||
> };
|
||
> ```
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- fast-deep-equal@3.1.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2017 Evgeny Poberezkin
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- fast-levenshtein@2.0.6
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(MIT License)
|
||
|
||
Copyright (c) 2013 [Ramesh Nair](http://www.hiddentao.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- fast-safe-stringify@2.0.7
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2016 David Mark Clements
|
||
Copyright (c) 2017 David Mark Clements & Matteo Collina
|
||
Copyright (c) 2018 David Mark Clements, Matteo Collina & Ruben Bridgewater
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- faye-websocket@0.11.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2010-2019 James Coglan
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- fecha@4.2.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 Taylor Hakes
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- file-uri-to-path@1.0.0
|
||
- file-uri-to-path@2.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2014 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- filter-obj@1.1.0
|
||
- object-assign@4.1.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- finalhandler@1.1.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014-2017 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- firebase-admin@9.6.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
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 [yyyy] [name of copyright owner]
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- fn.name@1.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 Arnout Kazemier, Martijn Swaagman, the 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- follow-redirects@1.14.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2014–present Olivier Lalonde <olalonde@gmail.com>, James Talmage <james@talmage.io>, Ruben Verborgh
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- form-data@2.5.1
|
||
- form-data@3.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2012 Felix Geisendörfer (felix@debuggable.com) and 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- formidable@1.2.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2011-present Felix Geisendörfer, and 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- fresh@0.5.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2012 TJ Holowaychuk <tj@vision-media.ca>
|
||
Copyright (c) 2016-2017 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- fs-extra@8.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2011-2017 JP Richardson
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- function-bind@1.1.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2013 Raynos.
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- functional-red-black-tree@1.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2013 Mikola Lysenko
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- gcs-resumable-upload@3.1.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2018 Google LLC
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- get-stream@6.0.0
|
||
- onetime@5.1.2
|
||
- p-limit@3.1.0
|
||
- yocto-queue@0.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- get-uri@2.0.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
get-uri
|
||
=======
|
||
### Returns a `stream.Readable` from a URI string
|
||
[](https://travis-ci.org/TooTallNate/node-get-uri)
|
||
|
||
This high-level module accepts a URI string and returns a `Readable` stream
|
||
instance. There is built-in support for a variety of "protocols", and it's
|
||
easily extensible with more:
|
||
|
||
| Protocol | Description | Example
|
||
|:---------:|:-------------------------------:|:---------------------------------:
|
||
| `data` | [Data URIs][data] | `data:text/plain;base64,SGVsbG8sIFdvcmxkIQ%3D%3D`
|
||
| `file` | [File URIs][file] | `file:///c:/windows/example.ini`
|
||
| `ftp` | [FTP URIs][ftp] | `ftp://ftp.kernel.org/pub/site/README`
|
||
| `http` | [HTTP URIs][http] | `http://www.example.com/path/to/name`
|
||
| `https` | [HTTPS URIs][https] | `https://www.example.com/path/to/name`
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install get-uri
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
To simply get a `stream.Readable` instance from a `file:` URI, try something like:
|
||
|
||
``` js
|
||
var getUri = require('get-uri');
|
||
|
||
// `file:` maps to a `fs.ReadStream` instance…
|
||
getUri('file:///Users/nrajlich/wat.json', function (err, rs) {
|
||
if (err) throw err;
|
||
rs.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
|
||
Missing Endpoints
|
||
-----------------
|
||
|
||
When you pass in a URI in which the resource referenced does not exist on the
|
||
destination server, then a `NotFoundError` will be returned. The `code` of the
|
||
error instance is set to `"ENOTFOUND"`, so you can special-case that in your code
|
||
to detect when a bad filename is requested:
|
||
|
||
``` js
|
||
getUri('http://example.com/resource.json', function (err, rs) {
|
||
if (err) {
|
||
if ('ENOTFOUND' == err.code) {
|
||
// bad file path requested
|
||
} else {
|
||
// something else bad happened...
|
||
throw err;
|
||
}
|
||
}
|
||
|
||
// your app code…
|
||
});
|
||
```
|
||
|
||
|
||
Cacheability
|
||
------------
|
||
|
||
When calling `getUri()` with the same URI multiple times, the `get-uri` module
|
||
supports sending an indicator that the remote resource has not been modified
|
||
since the last time it has been retreived from that node process.
|
||
|
||
To do this, pass in a `cache` option to the "options object" argument
|
||
with the value set to the `stream.Readable` instance that was previously
|
||
returned. If the remote resource has not been changed since the last call for
|
||
that same URI, then a `NotModifiedError` instance will be returned with it's
|
||
`code` property set to `"ENOTMODIFIED"`.
|
||
|
||
When the `"ENOTMODIFIED"` error occurs, then you can safely re-use the
|
||
results from the previous `getUri()` call for that same URI:
|
||
|
||
``` js
|
||
// maps to a `fs.ReadStream` instance
|
||
getUri('http://example.com/resource.json', function (err, rs) {
|
||
if (err) throw err;
|
||
|
||
// … some time later, if you need to get this same URI again, pass in the
|
||
// previous `stream.Readable` instance as `cache` option to potentially
|
||
// receive an "ENOTMODIFIED" response:
|
||
var opts = { cache: rs };
|
||
getUri('http://example.com/resource.json', opts, function (err, rs2) {
|
||
if (err) {
|
||
if ('ENOTFOUND' == err.code) {
|
||
// bad file path requested
|
||
} else if ('ENOTMODIFIED' == err.code) {
|
||
// source file has not been modified since last time it was requested,
|
||
// so `rs2` is undefined and you are expected to re-use results from
|
||
// a previous call to `getUri()`
|
||
} else {
|
||
// something else bad happened...
|
||
throw err;
|
||
}
|
||
}
|
||
});
|
||
});
|
||
```
|
||
|
||
|
||
API
|
||
---
|
||
|
||
### getUri(String uri[, Object options,] Function callback)
|
||
|
||
A `uri` String is required. An optional `options` object may be passed in:
|
||
|
||
- `cache` - A `stream.Readable` instance from a previous call to `getUri()` with the same URI. If this option is passed in, and the destination endpoint has not been modified, then an `ENOTMODIFIED` error is returned
|
||
|
||
Any other options passed in to the `options` object will be passed through
|
||
to the low-level connection creation functions (`http.get()`, `ftp.connect()`,
|
||
etc).
|
||
|
||
Invokes the given `callback` function with a `stream.Readable` instance to
|
||
read the resource at the given `uri`.
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
[data]: http://tools.ietf.org/html/rfc2397
|
||
[file]: http://tools.ietf.org/html/draft-hoffman-file-uri-03
|
||
[ftp]: http://www.w3.org/Protocols/rfc959/
|
||
[http]: http://www.w3.org/Protocols/rfc2616/rfc2616.html
|
||
[https]: http://wikipedia.org/wiki/HTTP_Secure
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- get-uri@3.0.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
get-uri
|
||
=======
|
||
### Returns a `stream.Readable` from a URI string
|
||
[](https://github.com/TooTallNate/node-get-uri/actions?workflow=Node+CI)
|
||
|
||
This high-level module accepts a URI string and returns a `Readable` stream
|
||
instance. There is built-in support for a variety of "protocols", and it's
|
||
easily extensible with more:
|
||
|
||
| Protocol | Description | Example
|
||
|:---------:|:-------------------------------:|:---------------------------------:
|
||
| `data` | [Data URIs][data] | `data:text/plain;base64,SGVsbG8sIFdvcmxkIQ%3D%3D`
|
||
| `file` | [File URIs][file] | `file:///c:/windows/example.ini`
|
||
| `ftp` | [FTP URIs][ftp] | `ftp://ftp.kernel.org/pub/site/README`
|
||
| `http` | [HTTP URIs][http] | `http://www.example.com/path/to/name`
|
||
| `https` | [HTTPS URIs][https] | `https://www.example.com/path/to/name`
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install get-uri
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
To simply get a `stream.Readable` instance from a `file:` URI, try something like:
|
||
|
||
``` js
|
||
var getUri = require('get-uri');
|
||
|
||
// `file:` maps to a `fs.ReadStream` instance…
|
||
getUri('file:///Users/nrajlich/wat.json', function (err, rs) {
|
||
if (err) throw err;
|
||
rs.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
|
||
Missing Endpoints
|
||
-----------------
|
||
|
||
When you pass in a URI in which the resource referenced does not exist on the
|
||
destination server, then a `NotFoundError` will be returned. The `code` of the
|
||
error instance is set to `"ENOTFOUND"`, so you can special-case that in your code
|
||
to detect when a bad filename is requested:
|
||
|
||
``` js
|
||
getUri('http://example.com/resource.json', function (err, rs) {
|
||
if (err) {
|
||
if ('ENOTFOUND' == err.code) {
|
||
// bad file path requested
|
||
} else {
|
||
// something else bad happened...
|
||
throw err;
|
||
}
|
||
}
|
||
|
||
// your app code…
|
||
});
|
||
```
|
||
|
||
|
||
Cacheability
|
||
------------
|
||
|
||
When calling `getUri()` with the same URI multiple times, the `get-uri` module
|
||
supports sending an indicator that the remote resource has not been modified
|
||
since the last time it has been retreived from that node process.
|
||
|
||
To do this, pass in a `cache` option to the "options object" argument
|
||
with the value set to the `stream.Readable` instance that was previously
|
||
returned. If the remote resource has not been changed since the last call for
|
||
that same URI, then a `NotModifiedError` instance will be returned with it's
|
||
`code` property set to `"ENOTMODIFIED"`.
|
||
|
||
When the `"ENOTMODIFIED"` error occurs, then you can safely re-use the
|
||
results from the previous `getUri()` call for that same URI:
|
||
|
||
``` js
|
||
// maps to a `fs.ReadStream` instance
|
||
getUri('http://example.com/resource.json', function (err, rs) {
|
||
if (err) throw err;
|
||
|
||
// … some time later, if you need to get this same URI again, pass in the
|
||
// previous `stream.Readable` instance as `cache` option to potentially
|
||
// receive an "ENOTMODIFIED" response:
|
||
var opts = { cache: rs };
|
||
getUri('http://example.com/resource.json', opts, function (err, rs2) {
|
||
if (err) {
|
||
if ('ENOTFOUND' == err.code) {
|
||
// bad file path requested
|
||
} else if ('ENOTMODIFIED' == err.code) {
|
||
// source file has not been modified since last time it was requested,
|
||
// so `rs2` is undefined and you are expected to re-use results from
|
||
// a previous call to `getUri()`
|
||
} else {
|
||
// something else bad happened...
|
||
throw err;
|
||
}
|
||
}
|
||
});
|
||
});
|
||
```
|
||
|
||
|
||
API
|
||
---
|
||
|
||
### getUri(String uri[, Object options,] Function callback)
|
||
|
||
A `uri` String is required. An optional `options` object may be passed in:
|
||
|
||
- `cache` - A `stream.Readable` instance from a previous call to `getUri()` with the same URI. If this option is passed in, and the destination endpoint has not been modified, then an `ENOTMODIFIED` error is returned
|
||
|
||
Any other options passed in to the `options` object will be passed through
|
||
to the low-level connection creation functions (`http.get()`, `ftp.connect()`,
|
||
etc).
|
||
|
||
Invokes the given `callback` function with a `stream.Readable` instance to
|
||
read the resource at the given `uri`.
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
[data]: http://tools.ietf.org/html/rfc2397
|
||
[file]: http://tools.ietf.org/html/draft-hoffman-file-uri-03
|
||
[ftp]: http://www.w3.org/Protocols/rfc959/
|
||
[http]: http://www.w3.org/Protocols/rfc2616/rfc2616.html
|
||
[https]: http://wikipedia.org/wiki/HTTP_Secure
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- google-p12-pem@3.0.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014 Ryan Seys
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- graceful-fs@4.2.6
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The ISC License
|
||
|
||
Copyright (c) Isaac Z. Schlueter, Ben Noordhuis, and Contributors
|
||
|
||
Permission to use, copy, modify, and/or distribute this software for any
|
||
purpose with or without fee is hereby granted, provided that the above
|
||
copyright notice and this permission notice appear in all copies.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
|
||
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- graphql-request@3.4.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2017 Graphcool
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- graphql@15.5.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) GraphQL 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- gtoken@5.2.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014 Ryan Seys
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- has-symbols@1.0.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2016 Jordan Harband
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- has@1.0.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2013 Thiago de Arruda
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- hash-stream-validation@0.2.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 Stephen Sawchuk
|
||
|
||
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.
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 Xiaoyi Shi
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- htmlparser2@3.10.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2010, 2011, Chris Winberry <chris@winberry.net>. All rights reserved.
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- http-errors@1.7.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014 Jonathan Ong me@jongleberry.com
|
||
Copyright (c) 2016 Douglas Christopher Wilson doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- http-parser-js@0.5.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2015 Tim Caswell (https://github.com/creationix) and other
|
||
contributors. All rights reserved.
|
||
|
||
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.
|
||
|
||
|
||
Some files from the tests folder are from joyent/node and mscedex/io.js, a fork
|
||
of nodejs/io.js:
|
||
|
||
- tests/iojs/test-http-parser-durability.js
|
||
|
||
This file is from https://github.com/mscdex/io.js/blob/js-http-parser/test/pummel/test-http-parser-durability.js
|
||
with modifications by Jan Schär (jscissr).
|
||
|
||
"""
|
||
Copyright io.js contributors. All rights reserved.
|
||
|
||
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.
|
||
"""
|
||
|
||
- tests/fixtures/*
|
||
tests/parallel/*
|
||
tests/testpy/*
|
||
tests/common.js
|
||
tests/test.py
|
||
tests/utils.py
|
||
|
||
These files are from https://github.com/nodejs/node with changes by
|
||
Jan Schär (jscissr).
|
||
|
||
Node.js is licensed for use as follows:
|
||
|
||
"""
|
||
Copyright Node.js contributors. All rights reserved.
|
||
|
||
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.
|
||
"""
|
||
|
||
This license applies to parts of Node.js originating from the
|
||
https://github.com/joyent/node repository:
|
||
|
||
"""
|
||
Copyright Joyent, Inc. and other Node contributors. All rights reserved.
|
||
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.
|
||
"""
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- http-proxy-agent@2.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
http-proxy-agent
|
||
================
|
||
### An HTTP(s) proxy `http.Agent` implementation for HTTP
|
||
[](https://travis-ci.org/TooTallNate/node-http-proxy-agent)
|
||
|
||
This module provides an `http.Agent` implementation that connects to a specified
|
||
HTTP or HTTPS proxy server, and can be used with the built-in `http` module.
|
||
|
||
__Note:__ For HTTP proxy usage with the `https` module, check out
|
||
[`node-https-proxy-agent`](https://github.com/TooTallNate/node-https-proxy-agent).
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install http-proxy-agent
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
``` js
|
||
var url = require('url');
|
||
var http = require('http');
|
||
var HttpProxyAgent = require('http-proxy-agent');
|
||
|
||
// HTTP/HTTPS proxy to connect to
|
||
var proxy = process.env.http_proxy || 'http://168.63.76.32:3128';
|
||
console.log('using proxy server %j', proxy);
|
||
|
||
// HTTP endpoint for the proxy to connect to
|
||
var endpoint = process.argv[2] || 'http://nodejs.org/api/';
|
||
console.log('attempting to GET %j', endpoint);
|
||
var opts = url.parse(endpoint);
|
||
|
||
// create an instance of the `HttpProxyAgent` class with the proxy server information
|
||
var agent = new HttpProxyAgent(proxy);
|
||
opts.agent = agent;
|
||
|
||
http.get(opts, function (res) {
|
||
console.log('"response" event!', res.headers);
|
||
res.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- http-proxy-agent@4.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
http-proxy-agent
|
||
================
|
||
### An HTTP(s) proxy `http.Agent` implementation for HTTP
|
||
[](https://github.com/TooTallNate/node-http-proxy-agent/actions?workflow=Node+CI)
|
||
|
||
This module provides an `http.Agent` implementation that connects to a specified
|
||
HTTP or HTTPS proxy server, and can be used with the built-in `http` module.
|
||
|
||
__Note:__ For HTTP proxy usage with the `https` module, check out
|
||
[`node-https-proxy-agent`](https://github.com/TooTallNate/node-https-proxy-agent).
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install http-proxy-agent
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
``` js
|
||
var url = require('url');
|
||
var http = require('http');
|
||
var HttpProxyAgent = require('http-proxy-agent');
|
||
|
||
// HTTP/HTTPS proxy to connect to
|
||
var proxy = process.env.http_proxy || 'http://168.63.76.32:3128';
|
||
console.log('using proxy server %j', proxy);
|
||
|
||
// HTTP endpoint for the proxy to connect to
|
||
var endpoint = process.argv[2] || 'http://nodejs.org/api/';
|
||
console.log('attempting to GET %j', endpoint);
|
||
var opts = url.parse(endpoint);
|
||
|
||
// create an instance of the `HttpProxyAgent` class with the proxy server information
|
||
var agent = new HttpProxyAgent(proxy);
|
||
opts.agent = agent;
|
||
|
||
http.get(opts, function (res) {
|
||
console.log('"response" event!', res.headers);
|
||
res.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- https-proxy-agent@2.2.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
https-proxy-agent
|
||
================
|
||
### An HTTP(s) proxy `http.Agent` implementation for HTTPS
|
||
[](https://travis-ci.org/TooTallNate/node-https-proxy-agent)
|
||
|
||
This module provides an `http.Agent` implementation that connects to a specified
|
||
HTTP or HTTPS proxy server, and can be used with the built-in `https` module.
|
||
|
||
Specifically, this `Agent` implementation connects to an intermediary "proxy"
|
||
server and issues the [CONNECT HTTP method][CONNECT], which tells the proxy to
|
||
open a direct TCP connection to the destination server.
|
||
|
||
Since this agent implements the CONNECT HTTP method, it also works with other
|
||
protocols that use this method when connecting over proxies (i.e. WebSockets).
|
||
See the "Examples" section below for more.
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install https-proxy-agent
|
||
```
|
||
|
||
|
||
Examples
|
||
--------
|
||
|
||
#### `https` module example
|
||
|
||
``` js
|
||
var url = require('url');
|
||
var https = require('https');
|
||
var HttpsProxyAgent = require('https-proxy-agent');
|
||
|
||
// HTTP/HTTPS proxy to connect to
|
||
var proxy = process.env.http_proxy || 'http://168.63.76.32:3128';
|
||
console.log('using proxy server %j', proxy);
|
||
|
||
// HTTPS endpoint for the proxy to connect to
|
||
var endpoint = process.argv[2] || 'https://graph.facebook.com/tootallnate';
|
||
console.log('attempting to GET %j', endpoint);
|
||
var options = url.parse(endpoint);
|
||
|
||
// create an instance of the `HttpsProxyAgent` class with the proxy server information
|
||
var agent = new HttpsProxyAgent(proxy);
|
||
options.agent = agent;
|
||
|
||
https.get(options, function (res) {
|
||
console.log('"response" event!', res.headers);
|
||
res.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
#### `ws` WebSocket connection example
|
||
|
||
``` js
|
||
var url = require('url');
|
||
var WebSocket = require('ws');
|
||
var HttpsProxyAgent = require('https-proxy-agent');
|
||
|
||
// HTTP/HTTPS proxy to connect to
|
||
var proxy = process.env.http_proxy || 'http://168.63.76.32:3128';
|
||
console.log('using proxy server %j', proxy);
|
||
|
||
// WebSocket endpoint for the proxy to connect to
|
||
var endpoint = process.argv[2] || 'ws://echo.websocket.org';
|
||
var parsed = url.parse(endpoint);
|
||
console.log('attempting to connect to WebSocket %j', endpoint);
|
||
|
||
// create an instance of the `HttpsProxyAgent` class with the proxy server information
|
||
var options = url.parse(proxy);
|
||
|
||
var agent = new HttpsProxyAgent(options);
|
||
|
||
// finally, initiate the WebSocket connection
|
||
var socket = new WebSocket(endpoint, { agent: agent });
|
||
|
||
socket.on('open', function () {
|
||
console.log('"open" event!');
|
||
socket.send('hello world');
|
||
});
|
||
|
||
socket.on('message', function (data, flags) {
|
||
console.log('"message" event! %j %j', data, flags);
|
||
socket.close();
|
||
});
|
||
```
|
||
|
||
API
|
||
---
|
||
|
||
### new HttpsProxyAgent(Object options)
|
||
|
||
The `HttpsProxyAgent` class implements an `http.Agent` subclass that connects
|
||
to the specified "HTTP(s) proxy server" in order to proxy HTTPS and/or WebSocket
|
||
requests. This is achieved by using the [HTTP `CONNECT` method][CONNECT].
|
||
|
||
The `options` argument may either be a string URI of the proxy server to use, or an
|
||
"options" object with more specific properties:
|
||
|
||
* `host` - String - Proxy host to connect to (may use `hostname` as well). Required.
|
||
* `port` - Number - Proxy port to connect to. Required.
|
||
* `protocol` - String - If `https:`, then use TLS to connect to the proxy.
|
||
* `headers` - Object - Additional HTTP headers to be sent on the HTTP CONNECT method.
|
||
* Any other options given are passed to the `net.connect()`/`tls.connect()` functions.
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
[CONNECT]: http://en.wikipedia.org/wiki/HTTP_tunnel#HTTP_CONNECT_Tunneling
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- https-proxy-agent@5.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
https-proxy-agent
|
||
================
|
||
### An HTTP(s) proxy `http.Agent` implementation for HTTPS
|
||
[](https://github.com/TooTallNate/node-https-proxy-agent/actions?workflow=Node+CI)
|
||
|
||
This module provides an `http.Agent` implementation that connects to a specified
|
||
HTTP or HTTPS proxy server, and can be used with the built-in `https` module.
|
||
|
||
Specifically, this `Agent` implementation connects to an intermediary "proxy"
|
||
server and issues the [CONNECT HTTP method][CONNECT], which tells the proxy to
|
||
open a direct TCP connection to the destination server.
|
||
|
||
Since this agent implements the CONNECT HTTP method, it also works with other
|
||
protocols that use this method when connecting over proxies (i.e. WebSockets).
|
||
See the "Examples" section below for more.
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install https-proxy-agent
|
||
```
|
||
|
||
|
||
Examples
|
||
--------
|
||
|
||
#### `https` module example
|
||
|
||
``` js
|
||
var url = require('url');
|
||
var https = require('https');
|
||
var HttpsProxyAgent = require('https-proxy-agent');
|
||
|
||
// HTTP/HTTPS proxy to connect to
|
||
var proxy = process.env.http_proxy || 'http://168.63.76.32:3128';
|
||
console.log('using proxy server %j', proxy);
|
||
|
||
// HTTPS endpoint for the proxy to connect to
|
||
var endpoint = process.argv[2] || 'https://graph.facebook.com/tootallnate';
|
||
console.log('attempting to GET %j', endpoint);
|
||
var options = url.parse(endpoint);
|
||
|
||
// create an instance of the `HttpsProxyAgent` class with the proxy server information
|
||
var agent = new HttpsProxyAgent(proxy);
|
||
options.agent = agent;
|
||
|
||
https.get(options, function (res) {
|
||
console.log('"response" event!', res.headers);
|
||
res.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
#### `ws` WebSocket connection example
|
||
|
||
``` js
|
||
var url = require('url');
|
||
var WebSocket = require('ws');
|
||
var HttpsProxyAgent = require('https-proxy-agent');
|
||
|
||
// HTTP/HTTPS proxy to connect to
|
||
var proxy = process.env.http_proxy || 'http://168.63.76.32:3128';
|
||
console.log('using proxy server %j', proxy);
|
||
|
||
// WebSocket endpoint for the proxy to connect to
|
||
var endpoint = process.argv[2] || 'ws://echo.websocket.org';
|
||
var parsed = url.parse(endpoint);
|
||
console.log('attempting to connect to WebSocket %j', endpoint);
|
||
|
||
// create an instance of the `HttpsProxyAgent` class with the proxy server information
|
||
var options = url.parse(proxy);
|
||
|
||
var agent = new HttpsProxyAgent(options);
|
||
|
||
// finally, initiate the WebSocket connection
|
||
var socket = new WebSocket(endpoint, { agent: agent });
|
||
|
||
socket.on('open', function () {
|
||
console.log('"open" event!');
|
||
socket.send('hello world');
|
||
});
|
||
|
||
socket.on('message', function (data, flags) {
|
||
console.log('"message" event! %j %j', data, flags);
|
||
socket.close();
|
||
});
|
||
```
|
||
|
||
API
|
||
---
|
||
|
||
### new HttpsProxyAgent(Object options)
|
||
|
||
The `HttpsProxyAgent` class implements an `http.Agent` subclass that connects
|
||
to the specified "HTTP(s) proxy server" in order to proxy HTTPS and/or WebSocket
|
||
requests. This is achieved by using the [HTTP `CONNECT` method][CONNECT].
|
||
|
||
The `options` argument may either be a string URI of the proxy server to use, or an
|
||
"options" object with more specific properties:
|
||
|
||
* `host` - String - Proxy host to connect to (may use `hostname` as well). Required.
|
||
* `port` - Number - Proxy port to connect to. Required.
|
||
* `protocol` - String - If `https:`, then use TLS to connect to the proxy.
|
||
* `headers` - Object - Additional HTTP headers to be sent on the HTTP CONNECT method.
|
||
* Any other options given are passed to the `net.connect()`/`tls.connect()` functions.
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
[CONNECT]: http://en.wikipedia.org/wiki/HTTP_tunnel#HTTP_CONNECT_Tunneling
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- iconv-lite@0.4.24
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2011 Alexander Shtuchkin
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- ieee754@1.1.13
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2008 Fair Oaks Labs, Inc.
|
||
|
||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||
|
||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||
|
||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||
|
||
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- imurmurhash@0.1.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
iMurmurHash.js
|
||
==============
|
||
|
||
An incremental implementation of the MurmurHash3 (32-bit) hashing algorithm for JavaScript based on [Gary Court's implementation](https://github.com/garycourt/murmurhash-js) with [kazuyukitanimura's modifications](https://github.com/kazuyukitanimura/murmurhash-js).
|
||
|
||
This version works significantly faster than the non-incremental version if you need to hash many small strings into a single hash, since string concatenation (to build the single string to pass the non-incremental version) is fairly costly. In one case tested, using the incremental version was about 50% faster than concatenating 5-10 strings and then hashing.
|
||
|
||
Installation
|
||
------------
|
||
|
||
To use iMurmurHash in the browser, [download the latest version](https://raw.github.com/jensyt/imurmurhash-js/master/imurmurhash.min.js) and include it as a script on your site.
|
||
|
||
```html
|
||
<script type="text/javascript" src="/scripts/imurmurhash.min.js"></script>
|
||
<script>
|
||
// Your code here, access iMurmurHash using the global object MurmurHash3
|
||
</script>
|
||
```
|
||
|
||
---
|
||
|
||
To use iMurmurHash in Node.js, install the module using NPM:
|
||
|
||
```bash
|
||
npm install imurmurhash
|
||
```
|
||
|
||
Then simply include it in your scripts:
|
||
|
||
```javascript
|
||
MurmurHash3 = require('imurmurhash');
|
||
```
|
||
|
||
Quick Example
|
||
-------------
|
||
|
||
```javascript
|
||
// Create the initial hash
|
||
var hashState = MurmurHash3('string');
|
||
|
||
// Incrementally add text
|
||
hashState.hash('more strings');
|
||
hashState.hash('even more strings');
|
||
|
||
// All calls can be chained if desired
|
||
hashState.hash('and').hash('some').hash('more');
|
||
|
||
// Get a result
|
||
hashState.result();
|
||
// returns 0xe4ccfe6b
|
||
```
|
||
|
||
Functions
|
||
---------
|
||
|
||
### MurmurHash3 ([string], [seed])
|
||
Get a hash state object, optionally initialized with the given _string_ and _seed_. _Seed_ must be a positive integer if provided. Calling this function without the `new` keyword will return a cached state object that has been reset. This is safe to use as long as the object is only used from a single thread and no other hashes are created while operating on this one. If this constraint cannot be met, you can use `new` to create a new state object. For example:
|
||
|
||
```javascript
|
||
// Use the cached object, calling the function again will return the same
|
||
// object (but reset, so the current state would be lost)
|
||
hashState = MurmurHash3();
|
||
...
|
||
|
||
// Create a new object that can be safely used however you wish. Calling the
|
||
// function again will simply return a new state object, and no state loss
|
||
// will occur, at the cost of creating more objects.
|
||
hashState = new MurmurHash3();
|
||
```
|
||
|
||
Both methods can be mixed however you like if you have different use cases.
|
||
|
||
---
|
||
|
||
### MurmurHash3.prototype.hash (string)
|
||
Incrementally add _string_ to the hash. This can be called as many times as you want for the hash state object, including after a call to `result()`. Returns `this` so calls can be chained.
|
||
|
||
---
|
||
|
||
### MurmurHash3.prototype.result ()
|
||
Get the result of the hash as a 32-bit positive integer. This performs the tail and finalizer portions of the algorithm, but does not store the result in the state object. This means that it is perfectly safe to get results and then continue adding strings via `hash`.
|
||
|
||
```javascript
|
||
// Do the whole string at once
|
||
MurmurHash3('this is a test string').result();
|
||
// 0x70529328
|
||
|
||
// Do part of the string, get a result, then the other part
|
||
var m = MurmurHash3('this is a');
|
||
m.result();
|
||
// 0xbfc4f834
|
||
m.hash(' test string').result();
|
||
// 0x70529328 (same as above)
|
||
```
|
||
|
||
---
|
||
|
||
### MurmurHash3.prototype.reset ([seed])
|
||
Reset the state object for reuse, optionally using the given _seed_ (defaults to 0 like the constructor). Returns `this` so calls can be chained.
|
||
|
||
---
|
||
|
||
License (MIT)
|
||
-------------
|
||
Copyright (c) 2013 Gary Court, Jens Taylor
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- inherits@2.0.3
|
||
- inherits@2.0.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The ISC License
|
||
|
||
Copyright (c) Isaac Z. Schlueter
|
||
|
||
Permission to use, copy, modify, and/or distribute this software for any
|
||
purpose with or without fee is hereby granted, provided that the above
|
||
copyright notice and this permission notice appear in all copies.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
||
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||
PERFORMANCE OF THIS SOFTWARE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- intuit-oauth@3.0.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
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 2018 Intuit, Inc.
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- ip@1.1.5
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# IP
|
||
[](https://www.npmjs.com/package/ip)
|
||
|
||
IP address utilities for node.js
|
||
|
||
## Installation
|
||
|
||
### npm
|
||
```shell
|
||
npm install ip
|
||
```
|
||
|
||
### git
|
||
|
||
```shell
|
||
git clone https://github.com/indutny/node-ip.git
|
||
```
|
||
|
||
## Usage
|
||
Get your ip address, compare ip addresses, validate ip addresses, etc.
|
||
|
||
```js
|
||
var ip = require('ip');
|
||
|
||
ip.address() // my ip address
|
||
ip.isEqual('::1', '::0:1'); // true
|
||
ip.toBuffer('127.0.0.1') // Buffer([127, 0, 0, 1])
|
||
ip.toString(new Buffer([127, 0, 0, 1])) // 127.0.0.1
|
||
ip.fromPrefixLen(24) // 255.255.255.0
|
||
ip.mask('192.168.1.134', '255.255.255.0') // 192.168.1.0
|
||
ip.cidr('192.168.1.134/26') // 192.168.1.128
|
||
ip.not('255.255.255.0') // 0.0.0.255
|
||
ip.or('192.168.1.134', '0.0.0.255') // 192.168.1.255
|
||
ip.isPrivate('127.0.0.1') // true
|
||
ip.isV4Format('127.0.0.1'); // true
|
||
ip.isV6Format('::ffff:127.0.0.1'); // true
|
||
|
||
// operate on buffers in-place
|
||
var buf = new Buffer(128);
|
||
var offset = 64;
|
||
ip.toBuffer('127.0.0.1', buf, offset); // [127, 0, 0, 1] at offset 64
|
||
ip.toString(buf, offset, 4); // '127.0.0.1'
|
||
|
||
// subnet information
|
||
ip.subnet('192.168.1.134', '255.255.255.192')
|
||
// { networkAddress: '192.168.1.128',
|
||
// firstAddress: '192.168.1.129',
|
||
// lastAddress: '192.168.1.190',
|
||
// broadcastAddress: '192.168.1.191',
|
||
// subnetMask: '255.255.255.192',
|
||
// subnetMaskLength: 26,
|
||
// numHosts: 62,
|
||
// length: 64,
|
||
// contains: function(addr){...} }
|
||
ip.cidrSubnet('192.168.1.134/26')
|
||
// Same as previous.
|
||
|
||
// range checking
|
||
ip.cidrSubnet('192.168.1.134/26').contains('192.168.1.190') // true
|
||
|
||
|
||
// ipv4 long conversion
|
||
ip.toLong('127.0.0.1'); // 2130706433
|
||
ip.fromLong(2130706433); // '127.0.0.1'
|
||
```
|
||
|
||
### License
|
||
|
||
This software is licensed under the MIT License.
|
||
|
||
Copyright Fedor Indutny, 2012.
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- ipaddr.js@1.9.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (C) 2011-2017 whitequark <whitequark@whitequark.org>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- is-arrayish@0.3.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 JD Ballard
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- is-stream-ended@0.1.4
|
||
- retry-request@4.1.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 Stephen Sawchuk
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- isarray@0.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# isarray
|
||
|
||
`Array#isArray` for older browsers.
|
||
|
||
## Usage
|
||
|
||
```js
|
||
var isArray = require('isarray');
|
||
|
||
console.log(isArray([])); // => true
|
||
console.log(isArray({})); // => false
|
||
```
|
||
|
||
## Installation
|
||
|
||
With [npm](http://npmjs.org) do
|
||
|
||
```bash
|
||
$ npm install isarray
|
||
```
|
||
|
||
Then bundle for the browser with
|
||
[browserify](https://github.com/substack/browserify).
|
||
|
||
With [component](http://component.io) do
|
||
|
||
```bash
|
||
$ component install juliangruber/isarray
|
||
```
|
||
|
||
## License
|
||
|
||
(MIT)
|
||
|
||
Copyright (c) 2013 Julian Gruber <julian@juliangruber.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- isarray@1.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# isarray
|
||
|
||
`Array#isArray` for older browsers.
|
||
|
||
[](http://travis-ci.org/juliangruber/isarray)
|
||
[](https://www.npmjs.org/package/isarray)
|
||
|
||
[
|
||
](https://ci.testling.com/juliangruber/isarray)
|
||
|
||
## Usage
|
||
|
||
```js
|
||
var isArray = require('isarray');
|
||
|
||
console.log(isArray([])); // => true
|
||
console.log(isArray({})); // => false
|
||
```
|
||
|
||
## Installation
|
||
|
||
With [npm](http://npmjs.org) do
|
||
|
||
```bash
|
||
$ npm install isarray
|
||
```
|
||
|
||
Then bundle for the browser with
|
||
[browserify](https://github.com/substack/browserify).
|
||
|
||
With [component](http://component.io) do
|
||
|
||
```bash
|
||
$ component install juliangruber/isarray
|
||
```
|
||
|
||
## License
|
||
|
||
(MIT)
|
||
|
||
Copyright (c) 2013 Julian Gruber <julian@juliangruber.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- jmespath@0.15.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2014 James Saryerwinnie
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- js-yaml@3.14.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (C) 2011-2015 by Vitaly Puzrin
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- json-bigint@0.2.3
|
||
- json-bigint@1.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2013 Andrey Sidorov
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- jsonfile@4.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2012-2015, JP Richardson <jprichardson@gmail.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- jsonwebtoken@8.5.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 Auth0, Inc. <support@auth0.com> (http://auth0.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- jwa@1.4.1
|
||
- jwa@2.0.0
|
||
- jws@3.2.2
|
||
- jws@4.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2013 Brian J. Brennan
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- kuler@2.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2014 Arnout Kazemier
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- levn@0.3.0
|
||
- optionator@0.8.3
|
||
- prelude-ls@1.1.2
|
||
- type-check@0.3.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) George Zahariev
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- lodash.assignin@4.2.0
|
||
- lodash.bind@4.2.1
|
||
- lodash.camelcase@4.3.0
|
||
- lodash.defaults@4.2.0
|
||
- lodash.filter@4.6.0
|
||
- lodash.flatten@4.4.0
|
||
- lodash.foreach@4.5.0
|
||
- lodash.includes@4.3.0
|
||
- lodash.isinteger@4.0.4
|
||
- lodash.isplainobject@4.0.6
|
||
- lodash.map@4.6.0
|
||
- lodash.once@4.1.1
|
||
- lodash.pick@4.4.0
|
||
- lodash.reduce@4.6.0
|
||
- lodash.reject@4.6.0
|
||
- lodash.some@4.6.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright jQuery Foundation and other contributors <https://jquery.org/>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- lodash.isboolean@3.0.3
|
||
- lodash.isnumber@3.0.3
|
||
- lodash.isstring@4.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2012-2016 The Dojo Foundation <http://dojofoundation.org/>
|
||
Based on Underscore.js, copyright 2009-2016 Jeremy Ashkenas,
|
||
DocumentCloud and Investigative Reporters & Editors <http://underscorejs.org/>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- lodash.merge@4.6.2
|
||
- lodash@4.17.21
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright OpenJS Foundation and other contributors <https://openjsf.org/>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- logform@2.2.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2017 Charlie Robbins & the 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- long@4.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
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 [yyyy] [name of copyright owner]
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- lru-cache@4.1.5
|
||
- lru-cache@5.1.1
|
||
- lru-cache@6.0.0
|
||
- once@1.4.0
|
||
- pseudomap@1.0.2
|
||
- semver@5.7.1
|
||
- semver@6.3.0
|
||
- semver@7.3.5
|
||
- wrappy@1.0.2
|
||
- yallist@2.1.2
|
||
- yallist@3.1.1
|
||
- yallist@4.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The ISC License
|
||
|
||
Copyright (c) Isaac Z. Schlueter and Contributors
|
||
|
||
Permission to use, copy, modify, and/or distribute this software for any
|
||
purpose with or without fee is hereby granted, provided that the above
|
||
copyright notice and this permission notice appear in all copies.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
|
||
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- make-error-cause@1.2.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2015 Blake Embrey
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- make-error@1.3.6
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2014 Julien Fontanet
|
||
|
||
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- media-typer@0.3.0
|
||
- on-headers@1.0.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014 Douglas Christopher Wilson
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- merge-descriptors@1.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Jonathan Ong <me@jongleberry.com>
|
||
Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- methods@1.1.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013-2014 TJ Holowaychuk <tj@vision-media.ca>
|
||
Copyright (c) 2015-2016 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- mime@1.6.0
|
||
- mime@2.5.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2010 Benjamin Thomas, Robert Kieffer
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- moment@2.29.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) JS Foundation and other 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- ms@2.0.0
|
||
- ms@2.1.1
|
||
- ms@2.1.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2016 Zeit, Inc.
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- ms@2.1.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2020 Vercel, Inc.
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- negotiator@0.6.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2012-2014 Federico Romero
|
||
Copyright (c) 2012-2014 Isaac Z. Schlueter
|
||
Copyright (c) 2014-2015 Douglas Christopher Wilson
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- netmask@1.0.6
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Netmask
|
||
=======
|
||
|
||
The Netmask class parses and understands IPv4 CIDR blocks so they can be explored and compared. This module is highly inspired by Perl [Net::Netmask](http://search.cpan.org/dist/Net-Netmask/) module.
|
||
|
||
Synopsis
|
||
--------
|
||
|
||
var Netmask = require('netmask').Netmask
|
||
|
||
var block = new Netmask('10.0.0.0/12');
|
||
block.base; // 10.0.0.0
|
||
block.mask; // 255.240.0.0
|
||
block.bitmask; // 12
|
||
block.hostmask; // 0.15.255.255
|
||
block.broadcast; // 10.15.255.255
|
||
block.size; // 1048576
|
||
block.first; // 10.0.0.1
|
||
block.last; // 10.15.255.254
|
||
|
||
block.contains('10.0.8.10'); // true
|
||
block.contains('10.8.0.10'); // true
|
||
block.contains('192.168.1.20'); // false
|
||
|
||
block.forEach(function(ip, long, index));
|
||
|
||
block.next() // Netmask('10.16.0.0/12')
|
||
|
||
Constructing
|
||
------------
|
||
|
||
Netmask objects are created with an IP address and optionally a mask. There are many forms that are recognized:
|
||
|
||
'216.240.32.0/24' // The preferred form.
|
||
'216.240.32.0/255.255.255.0'
|
||
'216.240.32.0', '255.255.255.0'
|
||
'216.240.32.0', 0xffffff00
|
||
'216.240.32.4' // A /32 block.
|
||
'216.240.32' // A /24 block.
|
||
'216.240' // A /16 block.
|
||
'140' // A /8 block.
|
||
'216.240.32/24'
|
||
'216.240/16'
|
||
|
||
API
|
||
---
|
||
|
||
- `.base`: The base address of the network block as a string (eg: 216.240.32.0). Base does not give an indication of the size of the network block.
|
||
- `.mask`: The netmask as a string (eg: 255.255.255.0).
|
||
- `.hostmask`: The host mask which is the opposite of the netmask (eg: 0.0.0.255).
|
||
- `.bitmask`: The netmask as a number of bits in the network portion of the address for this block (eg: 24).
|
||
- `.size`: The number of IP addresses in a block (eg: 256).
|
||
- `.broadcast`: The blocks broadcast address (eg: 192.168.1.0/24 => 192.168.1.255)
|
||
- `.first`, `.last`: First and last useable address
|
||
- `.contains(ip or block)`: Returns a true if the IP number `ip` is part of the network. That is, a true value is returned if `ip` is between `base` and `broadcast`. If a Netmask object or a block is given, it returns true only of the given block fits inside the network.
|
||
- `.forEach(fn)`: Similar to the Array prototype method. It loops through all the useable addresses, ie between `first` and `last`.
|
||
- `.next(count)`: Without a `count`, return the next block of the same size after the current one. With a count, return the Nth block after the current one. A count of -1 returns the previous block. Undef will be returned if out of legal address space.
|
||
- `.toString()`: The netmask in base/bitmask format (e.g., '216.240.32.0/24')
|
||
|
||
Installation
|
||
------------
|
||
|
||
$ npm install netmask
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2011 Olivier Poitrey <rs@dailymotion.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- netmask@2.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Netmask
|
||
=======
|
||
|
||
The Netmask class parses and understands IPv4 CIDR blocks so they can be explored and compared. This module is highly inspired by Perl [Net::Netmask](http://search.cpan.org/dist/Net-Netmask/) module.
|
||
|
||
Synopsis
|
||
--------
|
||
|
||
var Netmask = require('netmask').Netmask
|
||
|
||
var block = new Netmask('10.0.0.0/12');
|
||
block.base; // 10.0.0.0
|
||
block.mask; // 255.240.0.0
|
||
block.bitmask; // 12
|
||
block.hostmask; // 0.15.255.255
|
||
block.broadcast; // 10.15.255.255
|
||
block.size; // 1048576
|
||
block.first; // 10.0.0.1
|
||
block.last; // 10.15.255.254
|
||
|
||
block.contains('10.0.8.10'); // true
|
||
block.contains('10.8.0.10'); // true
|
||
block.contains('192.168.1.20'); // false
|
||
|
||
block.forEach(function(ip, long, index));
|
||
|
||
block.next() // Netmask('10.16.0.0/12')
|
||
|
||
Constructing
|
||
------------
|
||
|
||
Netmask objects are created with an IP address and optionally a mask. There are many forms that are recognized:
|
||
|
||
'216.240.32.0/24' // The preferred form.
|
||
'216.240.32.0/255.255.255.0'
|
||
'216.240.32.0', '255.255.255.0'
|
||
'216.240.32.0', 0xffffff00
|
||
'216.240.32.4' // A /32 block.
|
||
'0330.0360.040.04' // Octal form
|
||
'0xd8.0xf0.0x20.0x4' // Hex form
|
||
|
||
|
||
API
|
||
---
|
||
|
||
- `.base`: The base address of the network block as a string (eg: 216.240.32.0). Base does not give an indication of the size of the network block.
|
||
- `.mask`: The netmask as a string (eg: 255.255.255.0).
|
||
- `.hostmask`: The host mask which is the opposite of the netmask (eg: 0.0.0.255).
|
||
- `.bitmask`: The netmask as a number of bits in the network portion of the address for this block (eg: 24).
|
||
- `.size`: The number of IP addresses in a block (eg: 256).
|
||
- `.broadcast`: The blocks broadcast address (eg: 192.168.1.0/24 => 192.168.1.255)
|
||
- `.first`, `.last`: First and last useable address
|
||
- `.contains(ip or block)`: Returns a true if the IP number `ip` is part of the network. That is, a true value is returned if `ip` is between `base` and `broadcast`. If a Netmask object or a block is given, it returns true only of the given block fits inside the network.
|
||
- `.forEach(fn)`: Similar to the Array prototype method. It loops through all the useable addresses, ie between `first` and `last`.
|
||
- `.next(count)`: Without a `count`, return the next block of the same size after the current one. With a count, return the Nth block after the current one. A count of -1 returns the previous block. Undef will be returned if out of legal address space.
|
||
- `.toString()`: The netmask in base/bitmask format (e.g., '216.240.32.0/24')
|
||
|
||
Installation
|
||
------------
|
||
|
||
$ npm install netmask
|
||
|
||
Run all tests (vows plus mocha)
|
||
-------------------------------
|
||
|
||
$ npm test
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2011 Olivier Poitrey <rs@rhapsodyk.net>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- node-fetch@2.6.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2016 David Frank
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- node-forge@0.10.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
You may use the Forge project under the terms of either the BSD License or the
|
||
GNU General Public License (GPL) Version 2.
|
||
|
||
The BSD License is recommended for most projects. It is simple and easy to
|
||
understand and it places almost no restrictions on what you can do with the
|
||
Forge project.
|
||
|
||
If the GPL suits your project better you are also free to use Forge under
|
||
that license.
|
||
|
||
You don't have to do anything special to choose one license or the other and
|
||
you don't have to notify anyone which license you are using. You are free to
|
||
use this project in commercial projects as long as the copyright header is
|
||
left intact.
|
||
|
||
If you are a commercial entity and use this set of libraries in your
|
||
commercial software then reasonable payment to Digital Bazaar, if you can
|
||
afford it, is not required but is expected and would be appreciated. If this
|
||
library saves you time, then it's saving you money. The cost of developing
|
||
the Forge software was on the order of several hundred hours and tens of
|
||
thousands of dollars. We are attempting to strike a balance between helping
|
||
the development community while not being taken advantage of by lucrative
|
||
commercial entities for our efforts.
|
||
|
||
-------------------------------------------------------------------------------
|
||
New BSD License (3-clause)
|
||
Copyright (c) 2010, Digital Bazaar, Inc.
|
||
All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are met:
|
||
* Redistributions of source code must retain the above copyright
|
||
notice, this list of conditions and the following disclaimer.
|
||
* Redistributions in binary form must reproduce the above copyright
|
||
notice, this list of conditions and the following disclaimer in the
|
||
documentation and/or other materials provided with the distribution.
|
||
* Neither the name of Digital Bazaar, Inc. nor the
|
||
names of its contributors may be used to endorse or promote products
|
||
derived from this software without specific prior written permission.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
DISCLAIMED. IN NO EVENT SHALL DIGITAL BAZAAR BE LIABLE FOR ANY
|
||
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-------------------------------------------------------------------------------
|
||
GNU GENERAL PUBLIC LICENSE
|
||
Version 2, June 1991
|
||
|
||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||
Everyone is permitted to copy and distribute verbatim copies
|
||
of this license document, but changing it is not allowed.
|
||
|
||
Preamble
|
||
|
||
The licenses for most software are designed to take away your
|
||
freedom to share and change it. By contrast, the GNU General Public
|
||
License is intended to guarantee your freedom to share and change free
|
||
software--to make sure the software is free for all its users. This
|
||
General Public License applies to most of the Free Software
|
||
Foundation's software and to any other program whose authors commit to
|
||
using it. (Some other Free Software Foundation software is covered by
|
||
the GNU Lesser General Public License instead.) You can apply it to
|
||
your programs, too.
|
||
|
||
When we speak of free software, we are referring to freedom, not
|
||
price. Our General Public Licenses are designed to make sure that you
|
||
have the freedom to distribute copies of free software (and charge for
|
||
this service if you wish), that you receive source code or can get it
|
||
if you want it, that you can change the software or use pieces of it
|
||
in new free programs; and that you know you can do these things.
|
||
|
||
To protect your rights, we need to make restrictions that forbid
|
||
anyone to deny you these rights or to ask you to surrender the rights.
|
||
These restrictions translate to certain responsibilities for you if you
|
||
distribute copies of the software, or if you modify it.
|
||
|
||
For example, if you distribute copies of such a program, whether
|
||
gratis or for a fee, you must give the recipients all the rights that
|
||
you have. You must make sure that they, too, receive or can get the
|
||
source code. And you must show them these terms so they know their
|
||
rights.
|
||
|
||
We protect your rights with two steps: (1) copyright the software, and
|
||
(2) offer you this license which gives you legal permission to copy,
|
||
distribute and/or modify the software.
|
||
|
||
Also, for each author's protection and ours, we want to make certain
|
||
that everyone understands that there is no warranty for this free
|
||
software. If the software is modified by someone else and passed on, we
|
||
want its recipients to know that what they have is not the original, so
|
||
that any problems introduced by others will not reflect on the original
|
||
authors' reputations.
|
||
|
||
Finally, any free program is threatened constantly by software
|
||
patents. We wish to avoid the danger that redistributors of a free
|
||
program will individually obtain patent licenses, in effect making the
|
||
program proprietary. To prevent this, we have made it clear that any
|
||
patent must be licensed for everyone's free use or not licensed at all.
|
||
|
||
The precise terms and conditions for copying, distribution and
|
||
modification follow.
|
||
|
||
GNU GENERAL PUBLIC LICENSE
|
||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||
|
||
0. This License applies to any program or other work which contains
|
||
a notice placed by the copyright holder saying it may be distributed
|
||
under the terms of this General Public License. The "Program", below,
|
||
refers to any such program or work, and a "work based on the Program"
|
||
means either the Program or any derivative work under copyright law:
|
||
that is to say, a work containing the Program or a portion of it,
|
||
either verbatim or with modifications and/or translated into another
|
||
language. (Hereinafter, translation is included without limitation in
|
||
the term "modification".) Each licensee is addressed as "you".
|
||
|
||
Activities other than copying, distribution and modification are not
|
||
covered by this License; they are outside its scope. The act of
|
||
running the Program is not restricted, and the output from the Program
|
||
is covered only if its contents constitute a work based on the
|
||
Program (independent of having been made by running the Program).
|
||
Whether that is true depends on what the Program does.
|
||
|
||
1. You may copy and distribute verbatim copies of the Program's
|
||
source code as you receive it, in any medium, provided that you
|
||
conspicuously and appropriately publish on each copy an appropriate
|
||
copyright notice and disclaimer of warranty; keep intact all the
|
||
notices that refer to this License and to the absence of any warranty;
|
||
and give any other recipients of the Program a copy of this License
|
||
along with the Program.
|
||
|
||
You may charge a fee for the physical act of transferring a copy, and
|
||
you may at your option offer warranty protection in exchange for a fee.
|
||
|
||
2. You may modify your copy or copies of the Program or any portion
|
||
of it, thus forming a work based on the Program, and copy and
|
||
distribute such modifications or work under the terms of Section 1
|
||
above, provided that you also meet all of these conditions:
|
||
|
||
a) You must cause the modified files to carry prominent notices
|
||
stating that you changed the files and the date of any change.
|
||
|
||
b) You must cause any work that you distribute or publish, that in
|
||
whole or in part contains or is derived from the Program or any
|
||
part thereof, to be licensed as a whole at no charge to all third
|
||
parties under the terms of this License.
|
||
|
||
c) If the modified program normally reads commands interactively
|
||
when run, you must cause it, when started running for such
|
||
interactive use in the most ordinary way, to print or display an
|
||
announcement including an appropriate copyright notice and a
|
||
notice that there is no warranty (or else, saying that you provide
|
||
a warranty) and that users may redistribute the program under
|
||
these conditions, and telling the user how to view a copy of this
|
||
License. (Exception: if the Program itself is interactive but
|
||
does not normally print such an announcement, your work based on
|
||
the Program is not required to print an announcement.)
|
||
|
||
These requirements apply to the modified work as a whole. If
|
||
identifiable sections of that work are not derived from the Program,
|
||
and can be reasonably considered independent and separate works in
|
||
themselves, then this License, and its terms, do not apply to those
|
||
sections when you distribute them as separate works. But when you
|
||
distribute the same sections as part of a whole which is a work based
|
||
on the Program, the distribution of the whole must be on the terms of
|
||
this License, whose permissions for other licensees extend to the
|
||
entire whole, and thus to each and every part regardless of who wrote it.
|
||
|
||
Thus, it is not the intent of this section to claim rights or contest
|
||
your rights to work written entirely by you; rather, the intent is to
|
||
exercise the right to control the distribution of derivative or
|
||
collective works based on the Program.
|
||
|
||
In addition, mere aggregation of another work not based on the Program
|
||
with the Program (or with a work based on the Program) on a volume of
|
||
a storage or distribution medium does not bring the other work under
|
||
the scope of this License.
|
||
|
||
3. You may copy and distribute the Program (or a work based on it,
|
||
under Section 2) in object code or executable form under the terms of
|
||
Sections 1 and 2 above provided that you also do one of the following:
|
||
|
||
a) Accompany it with the complete corresponding machine-readable
|
||
source code, which must be distributed under the terms of Sections
|
||
1 and 2 above on a medium customarily used for software interchange; or,
|
||
|
||
b) Accompany it with a written offer, valid for at least three
|
||
years, to give any third party, for a charge no more than your
|
||
cost of physically performing source distribution, a complete
|
||
machine-readable copy of the corresponding source code, to be
|
||
distributed under the terms of Sections 1 and 2 above on a medium
|
||
customarily used for software interchange; or,
|
||
|
||
c) Accompany it with the information you received as to the offer
|
||
to distribute corresponding source code. (This alternative is
|
||
allowed only for noncommercial distribution and only if you
|
||
received the program in object code or executable form with such
|
||
an offer, in accord with Subsection b above.)
|
||
|
||
The source code for a work means the preferred form of the work for
|
||
making modifications to it. For an executable work, complete source
|
||
code means all the source code for all modules it contains, plus any
|
||
associated interface definition files, plus the scripts used to
|
||
control compilation and installation of the executable. However, as a
|
||
special exception, the source code distributed need not include
|
||
anything that is normally distributed (in either source or binary
|
||
form) with the major components (compiler, kernel, and so on) of the
|
||
operating system on which the executable runs, unless that component
|
||
itself accompanies the executable.
|
||
|
||
If distribution of executable or object code is made by offering
|
||
access to copy from a designated place, then offering equivalent
|
||
access to copy the source code from the same place counts as
|
||
distribution of the source code, even though third parties are not
|
||
compelled to copy the source along with the object code.
|
||
|
||
4. You may not copy, modify, sublicense, or distribute the Program
|
||
except as expressly provided under this License. Any attempt
|
||
otherwise to copy, modify, sublicense or distribute the Program is
|
||
void, and will automatically terminate your rights under this License.
|
||
However, parties who have received copies, or rights, from you under
|
||
this License will not have their licenses terminated so long as such
|
||
parties remain in full compliance.
|
||
|
||
5. You are not required to accept this License, since you have not
|
||
signed it. However, nothing else grants you permission to modify or
|
||
distribute the Program or its derivative works. These actions are
|
||
prohibited by law if you do not accept this License. Therefore, by
|
||
modifying or distributing the Program (or any work based on the
|
||
Program), you indicate your acceptance of this License to do so, and
|
||
all its terms and conditions for copying, distributing or modifying
|
||
the Program or works based on it.
|
||
|
||
6. Each time you redistribute the Program (or any work based on the
|
||
Program), the recipient automatically receives a license from the
|
||
original licensor to copy, distribute or modify the Program subject to
|
||
these terms and conditions. You may not impose any further
|
||
restrictions on the recipients' exercise of the rights granted herein.
|
||
You are not responsible for enforcing compliance by third parties to
|
||
this License.
|
||
|
||
7. If, as a consequence of a court judgment or allegation of patent
|
||
infringement or for any other reason (not limited to patent issues),
|
||
conditions are imposed on you (whether by court order, agreement or
|
||
otherwise) that contradict the conditions of this License, they do not
|
||
excuse you from the conditions of this License. If you cannot
|
||
distribute so as to satisfy simultaneously your obligations under this
|
||
License and any other pertinent obligations, then as a consequence you
|
||
may not distribute the Program at all. For example, if a patent
|
||
license would not permit royalty-free redistribution of the Program by
|
||
all those who receive copies directly or indirectly through you, then
|
||
the only way you could satisfy both it and this License would be to
|
||
refrain entirely from distribution of the Program.
|
||
|
||
If any portion of this section is held invalid or unenforceable under
|
||
any particular circumstance, the balance of the section is intended to
|
||
apply and the section as a whole is intended to apply in other
|
||
circumstances.
|
||
|
||
It is not the purpose of this section to induce you to infringe any
|
||
patents or other property right claims or to contest validity of any
|
||
such claims; this section has the sole purpose of protecting the
|
||
integrity of the free software distribution system, which is
|
||
implemented by public license practices. Many people have made
|
||
generous contributions to the wide range of software distributed
|
||
through that system in reliance on consistent application of that
|
||
system; it is up to the author/donor to decide if he or she is willing
|
||
to distribute software through any other system and a licensee cannot
|
||
impose that choice.
|
||
|
||
This section is intended to make thoroughly clear what is believed to
|
||
be a consequence of the rest of this License.
|
||
|
||
8. If the distribution and/or use of the Program is restricted in
|
||
certain countries either by patents or by copyrighted interfaces, the
|
||
original copyright holder who places the Program under this License
|
||
may add an explicit geographical distribution limitation excluding
|
||
those countries, so that distribution is permitted only in or among
|
||
countries not thus excluded. In such case, this License incorporates
|
||
the limitation as if written in the body of this License.
|
||
|
||
9. The Free Software Foundation may publish revised and/or new versions
|
||
of the General Public License from time to time. Such new versions will
|
||
be similar in spirit to the present version, but may differ in detail to
|
||
address new problems or concerns.
|
||
|
||
Each version is given a distinguishing version number. If the Program
|
||
specifies a version number of this License which applies to it and "any
|
||
later version", you have the option of following the terms and conditions
|
||
either of that version or of any later version published by the Free
|
||
Software Foundation. If the Program does not specify a version number of
|
||
this License, you may choose any version ever published by the Free Software
|
||
Foundation.
|
||
|
||
10. If you wish to incorporate parts of the Program into other free
|
||
programs whose distribution conditions are different, write to the author
|
||
to ask for permission. For software which is copyrighted by the Free
|
||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||
make exceptions for this. Our decision will be guided by the two goals
|
||
of preserving the free status of all derivatives of our free software and
|
||
of promoting the sharing and reuse of software generally.
|
||
|
||
NO WARRANTY
|
||
|
||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||
REPAIR OR CORRECTION.
|
||
|
||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||
POSSIBILITY OF SUCH DAMAGES.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- node-mailjet@3.3.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 Mailjet
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- nodemailer@6.5.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2011-2019 Andris Reinman
|
||
|
||
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 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- object-inspect@1.9.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2013 James Halliday
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- on-finished@2.3.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Jonathan Ong <me@jongleberry.com>
|
||
Copyright (c) 2014 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- one-time@1.0.0
|
||
- querystringify@2.2.0
|
||
- requires-port@1.0.0
|
||
- url-parse@1.5.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 Unshift.io, Arnout Kazemier, the 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- pac-proxy-agent@2.0.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
pac-proxy-agent
|
||
===============
|
||
### A [PAC file][pac-wikipedia] proxy `http.Agent` implementation for HTTP and HTTPS
|
||
[](https://travis-ci.org/TooTallNate/node-pac-proxy-agent)
|
||
|
||
This module provides an `http.Agent` implementation that retreives the specified
|
||
[PAC proxy file][pac-wikipedia] and uses it to resolve which HTTP, HTTPS, or
|
||
SOCKS proxy, or if a direct connection should be used to connect to the
|
||
HTTP endpoint.
|
||
|
||
It is designed to be be used with the built-in `http` and `https` modules.
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install pac-proxy-agent
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
``` js
|
||
var url = require('url');
|
||
var http = require('http');
|
||
var PacProxyAgent = require('pac-proxy-agent');
|
||
|
||
// URI to a PAC proxy file to use (the "pac+" prefix is stripped)
|
||
var proxy = 'pac+https://cloudup.com/ceGH2yZ0Bjp+';
|
||
console.log('using PAC proxy proxy file at %j', proxy);
|
||
|
||
// HTTP endpoint for the proxy to connect to
|
||
var endpoint = 'http://nodejs.org/api/';
|
||
console.log('attempting to GET %j', endpoint);
|
||
var opts = url.parse(endpoint);
|
||
|
||
// create an instance of the `PacProxyAgent` class with the PAC file location
|
||
var agent = new PacProxyAgent(proxy);
|
||
opts.agent = agent;
|
||
|
||
http.get(opts, function (res) {
|
||
console.log('"response" event!', res.headers);
|
||
res.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
[pac-wikipedia]: http://wikipedia.org/wiki/Proxy_auto-config
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- pac-proxy-agent@4.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
pac-proxy-agent
|
||
===============
|
||
### A [PAC file][pac-wikipedia] proxy `http.Agent` implementation for HTTP and HTTPS
|
||
[](https://github.com/TooTallNate/node-pac-proxy-agent/actions?workflow=Node+CI)
|
||
|
||
This module provides an `http.Agent` implementation that retreives the specified
|
||
[PAC proxy file][pac-wikipedia] and uses it to resolve which HTTP, HTTPS, or
|
||
SOCKS proxy, or if a direct connection should be used to connect to the
|
||
HTTP endpoint.
|
||
|
||
It is designed to be be used with the built-in `http` and `https` modules.
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install pac-proxy-agent
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
``` js
|
||
var url = require('url');
|
||
var http = require('http');
|
||
var PacProxyAgent = require('pac-proxy-agent');
|
||
|
||
// URI to a PAC proxy file to use (the "pac+" prefix is stripped)
|
||
var proxy = 'pac+https://cloudup.com/ceGH2yZ0Bjp+';
|
||
console.log('using PAC proxy proxy file at %j', proxy);
|
||
|
||
// HTTP endpoint for the proxy to connect to
|
||
var endpoint = 'http://nodejs.org/api/';
|
||
console.log('attempting to GET %j', endpoint);
|
||
var opts = url.parse(endpoint);
|
||
|
||
// create an instance of the `PacProxyAgent` class with the PAC file location
|
||
var agent = new PacProxyAgent(proxy);
|
||
opts.agent = agent;
|
||
|
||
http.get(opts, function (res) {
|
||
console.log('"response" event!', res.headers);
|
||
res.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
[pac-wikipedia]: http://wikipedia.org/wiki/Proxy_auto-config
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- pac-resolver@3.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
pac-resolver
|
||
============
|
||
### Generates an asynchronous resolver function from a [PAC file][pac-wikipedia]
|
||
[](https://travis-ci.org/TooTallNate/node-pac-resolver)
|
||
|
||
|
||
This module accepts a JavaScript String of code, which is meant to be a
|
||
[PAC proxy file][pac-wikipedia], and returns a generated asynchronous
|
||
`FindProxyForURL()` function.
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install pac-resolver
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
Given the PAC proxy file named `proxy.pac`:
|
||
|
||
``` js
|
||
function FindProxyForURL(url, host) {
|
||
if (isInNet(myIpAddress(), "10.1.10.0", "255.255.255.0")) {
|
||
return "PROXY 1.2.3.4:8080";
|
||
} else {
|
||
return "DIRECT";
|
||
}
|
||
}
|
||
```
|
||
|
||
You can consume this PAC file with `pac-resolver` like so:
|
||
|
||
``` js
|
||
var fs = require('fs');
|
||
var pac = require('pac-resolver');
|
||
|
||
var FindProxyForURL = pac(fs.readFileSync('proxy.pac'));
|
||
|
||
FindProxyForURL('http://foo.com/').then((res) => {
|
||
console.log(res);
|
||
// "DIRECT"
|
||
});
|
||
```
|
||
|
||
|
||
API
|
||
---
|
||
|
||
### pac(String jsStr[, Object options]) → Function
|
||
|
||
Returns an asynchronous `FindProxyForURL()` function based off of the given JS
|
||
string `jsStr` PAC proxy file. An optional `options` object may be passed in which
|
||
respects the following options:
|
||
|
||
* `filename` - String - the filename to use in error stack traces. Defaults to `proxy.pac`.
|
||
* `sandbox` - Object - a map of functions to include in the sandbox of the
|
||
JavaScript environment where the JS code will be executed. i.e. if you wanted to
|
||
include the common `alert` function you could pass `alert: console.log`. For
|
||
async functions, you must set the `async = true` property on the function
|
||
instance, and the JS code will be able to invoke the function as if it were
|
||
synchronous.
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
[pac-file-docs]: https://web.archive.org/web/20070602031929/http://wp.netscape.com/eng/mozilla/2.0/relnotes/demo/proxy-live.html
|
||
[pac-wikipedia]: http://wikipedia.org/wiki/Proxy_auto-config
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- pac-resolver@4.2.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
pac-resolver
|
||
============
|
||
### Generates an asynchronous resolver function from a [PAC file][pac-wikipedia]
|
||
[](https://github.com/TooTallNate/node-pac-resolver/actions?workflow=Node+CI)
|
||
|
||
|
||
This module accepts a JavaScript String of code, which is meant to be a
|
||
[PAC proxy file][pac-wikipedia], and returns a generated asynchronous
|
||
`FindProxyForURL()` function.
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
```bash
|
||
$ npm install pac-resolver
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
Given the PAC proxy file named `proxy.pac`:
|
||
|
||
```js
|
||
function FindProxyForURL(url, host) {
|
||
if (isInNet(myIpAddress(), "10.1.10.0", "255.255.255.0")) {
|
||
return "PROXY 1.2.3.4:8080";
|
||
} else {
|
||
return "DIRECT";
|
||
}
|
||
}
|
||
```
|
||
|
||
You can consume this PAC file with `pac-resolver` like so:
|
||
|
||
```js
|
||
var fs = require('fs');
|
||
var pac = require('pac-resolver');
|
||
|
||
var FindProxyForURL = pac(fs.readFileSync('proxy.pac'));
|
||
|
||
FindProxyForURL('http://foo.com/').then((res) => {
|
||
console.log(res);
|
||
// "DIRECT"
|
||
});
|
||
```
|
||
|
||
|
||
API
|
||
---
|
||
|
||
### pac(String pacFileContents[, Object options]) → Function
|
||
|
||
Returns an asynchronous `FindProxyForURL()` function based off of the given JS
|
||
string `pacFileContents` PAC proxy file. An optional `options` object may be
|
||
passed in which respects the following options:
|
||
|
||
* `filename` - String - the filename to use in error stack traces. Defaults to `proxy.pac`.
|
||
* `sandbox` - Object - a map of functions to include in the sandbox of the
|
||
JavaScript environment where the JS code will be executed. i.e. if you wanted to
|
||
include the common `alert` function you could pass `alert: console.log`. For
|
||
async functions, you must set the `async = true` property on the function
|
||
instance, and the JS code will be able to invoke the function as if it were
|
||
synchronous.
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
[pac-file-docs]: https://web.archive.org/web/20070602031929/http://wp.netscape.com/eng/mozilla/2.0/relnotes/demo/proxy-live.html
|
||
[pac-wikipedia]: http://wikipedia.org/wiki/Proxy_auto-config
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- parseurl@1.3.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
|
||
Copyright (c) 2014-2017 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- phone@2.4.21
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2013-2020 AfterShip
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- pop-iterate@1.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# Iterate
|
||
|
||
This JavaScript package exports an iterator operator that accepts arrays and any
|
||
object that implements iterate.
|
||
|
||
```
|
||
$ npm install --save pop-iterate
|
||
```
|
||
|
||
The iterate operator accepts an array, or object that implements iterate, and
|
||
returns an iterator, as described by the [iterator protocol][Iterator], with
|
||
some extensions.
|
||
The iterations have an index property with the index corresponding to the value.
|
||
|
||
[Iterator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/The_Iterator_protocol
|
||
|
||
```js
|
||
var iterator = iterate([1, 2, 3]);
|
||
expect(iterator.next()).toEqual({value: 1, done: false, index: 0});
|
||
expect(iterator.next()).toEqual({value: 2, done: false, index: 1});
|
||
expect(iterator.next()).toEqual({value: 3, done: false, index: 2});
|
||
expect(iterator.next()).toEqual({done: true});
|
||
```
|
||
|
||
Iterating on an array, the iterate method accepts optional start, stop, and step
|
||
arguments.
|
||
|
||
```js
|
||
var array = [1, 2, 3, 4, 5, 6, 7, 8];
|
||
var iterator = iterate(array, 1, 6, 2);
|
||
expect(iterator.next()).toEqual({value: 2, done: false, index: 1});
|
||
expect(iterator.next()).toEqual({value: 4, done: false, index: 3});
|
||
expect(iterator.next()).toEqual({value: 6, done: false, index: 5});
|
||
expect(iterator.next()).toEqual({done: true});
|
||
```
|
||
|
||
The iterate operator also iterates the owned properties of an object.
|
||
|
||
```js
|
||
var object = {a: 10, b: 20, c: 30};
|
||
var iterator = iterate(object);
|
||
expect(iterator.next()).toEqual({value: 10, done: false, index: "a"});
|
||
expect(iterator.next()).toEqual({value: 20, done: false, index: "b"});
|
||
expect(iterator.next()).toEqual({value: 30, done: false, index: "c"});
|
||
expect(iterator.next()).toEqual({done: true});
|
||
```
|
||
|
||
## Polymorphic operator
|
||
|
||
A well-planned system of objects is beautiful: a system where every meaningful
|
||
method for an object has been anticipated in the design.
|
||
Inevitably, another layer of architecture introduces a new concept and with it
|
||
the temptation to monkey-patch, dunk-punch, or otherwise cover-up the omission.
|
||
But reaching backward in time, up through the layers of architecture doesn't
|
||
always compose well, when different levels introduce concepts of the same name
|
||
but distinct behavior.
|
||
|
||
A polymorphic operator is a function that accepts as its first argument an
|
||
object and varies its behavior depending on its type.
|
||
Such an operator has the benefit of covering for the types from higher layers of
|
||
architecture, but defers to the eponymous method name of types yet to be
|
||
defined.
|
||
|
||
The iterate operator works for arrays and objects.
|
||
Any other object can be iterable by implementing the `iterate` method, and the
|
||
iterate operator will defer to it.
|
||
|
||
```js
|
||
function Collection() {}
|
||
Collection.prototype.iterate = function (start, stop, step) {
|
||
};
|
||
```
|
||
|
||
This package also exports the individual parts form which it makes iterators.
|
||
|
||
```js
|
||
var Iteration = require("pop-iterate/iteration");
|
||
var ArrayIterator = require("pop-iterate/array-iterator");
|
||
var ObjectIterator = require("pop-iterate/object-iterator");
|
||
```
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- process-nextick-args@2.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# Copyright (c) 2015 Calvin Metcalf
|
||
|
||
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.**
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- protobufjs@6.10.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
This license applies to all parts of protobuf.js except those files
|
||
either explicitly including or referencing a different license or
|
||
located in a directory containing a different LICENSE file.
|
||
|
||
---
|
||
|
||
Copyright (c) 2016, Daniel Wirtz All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are
|
||
met:
|
||
|
||
* Redistributions of source code must retain the above copyright
|
||
notice, this list of conditions and the following disclaimer.
|
||
* Redistributions in binary form must reproduce the above copyright
|
||
notice, this list of conditions and the following disclaimer in the
|
||
documentation and/or other materials provided with the distribution.
|
||
* Neither the name of its author, nor the names of its contributors
|
||
may be used to endorse or promote products derived from this software
|
||
without specific prior written permission.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
---
|
||
|
||
Code generated by the command line utilities is owned by the owner
|
||
of the input file used when generating it. This code is not
|
||
standalone and requires a support library to be linked with it. This
|
||
support library is itself covered by the above license.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- proxy-agent@2.3.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
proxy-agent
|
||
===========
|
||
### Maps proxy protocols to `http.Agent` implementations
|
||
[](https://travis-ci.org/TooTallNate/node-proxy-agent)
|
||
|
||
This module provides a function that returns proxying `http.Agent` instances to
|
||
use based off of a given proxy URI.
|
||
|
||
An LRU cache is used so that `http.Agent` instances are transparently re-used for
|
||
subsequent HTTP requests to the same proxy server.
|
||
|
||
The currently implemented protocol mappings are listed in the table below:
|
||
|
||
|
||
| Protocol | Proxy Agent for `http` requests | Proxy Agent for `https` requests | Example
|
||
|:----------:|:-------------------------------:|:--------------------------------:|:--------:
|
||
| `http` | [http-proxy-agent][] | [https-proxy-agent][] | `http://proxy-server-over-tcp.com:3128`
|
||
| `https` | [http-proxy-agent][] | [https-proxy-agent][] | `https://proxy-server-over-tls.com:3129`
|
||
| `socks(v5)`| [socks-proxy-agent][] | [socks-proxy-agent][] | `socks://username:password@some-socks-proxy.com:9050` (username & password are optional)
|
||
| `socks5` | [socks-proxy-agent][] | [socks-proxy-agent][] | `socks5://username:password@some-socks-proxy.com:9050` (username & password are optional)
|
||
| `socks4` | [socks-proxy-agent][] | [socks-proxy-agent][] | `socks4://some-socks-proxy.com:9050`
|
||
| `pac` | [pac-proxy-agent][] | [pac-proxy-agent][] | `pac+http://www.example.com/proxy.pac`
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install proxy-agent
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
``` js
|
||
var http = require('http');
|
||
var ProxyAgent = require('proxy-agent');
|
||
|
||
// HTTP, HTTPS, or SOCKS proxy to use
|
||
var proxyUri = process.env.http_proxy || 'http://168.63.43.102:3128';
|
||
|
||
var opts = {
|
||
method: 'GET',
|
||
host: 'jsonip.org',
|
||
path: '/',
|
||
// this is the important part!
|
||
agent: new ProxyAgent(proxyUri)
|
||
};
|
||
|
||
// the rest works just like any other normal HTTP request
|
||
http.get(opts, onresponse);
|
||
|
||
function onresponse (res) {
|
||
console.log(res.statusCode, res.headers);
|
||
res.pipe(process.stdout);
|
||
}
|
||
```
|
||
|
||
|
||
API
|
||
---
|
||
|
||
### new ProxyAgent(Object|String opts|uri)
|
||
|
||
Returns an `http.Agent` instance based off of the given proxy `opts` or URI
|
||
string. An LRU cache is used, so the same `http.Agent` instance will be
|
||
returned if identical args are passed in.
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
|
||
[http-proxy-agent]: https://github.com/TooTallNate/node-http-proxy-agent
|
||
[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent
|
||
[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent
|
||
[pac-proxy-agent]: https://github.com/TooTallNate/node-pac-proxy-agent
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- proxy-agent@4.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
proxy-agent
|
||
===========
|
||
### Maps proxy protocols to `http.Agent` implementations
|
||
[](https://travis-ci.org/TooTallNate/node-proxy-agent)
|
||
|
||
This module provides a function that returns proxying `http.Agent` instances to
|
||
use based off of a given proxy URI. If no URI is provided, then
|
||
[proxy-from-env](https://www.npmjs.com/package/proxy-from-env) is used to get the URI
|
||
from `$HTTP_PROXY`, `$HTTPS_PROXY` and `$NO_PROXY` among others.
|
||
|
||
An LRU cache is used so that `http.Agent` instances are transparently re-used for
|
||
subsequent HTTP requests to the same proxy server.
|
||
|
||
The currently implemented protocol mappings are listed in the table below:
|
||
|
||
|
||
| Protocol | Proxy Agent for `http` requests | Proxy Agent for `https` requests | Example
|
||
|:----------:|:-------------------------------:|:--------------------------------:|:--------:
|
||
| `http` | [http-proxy-agent][] | [https-proxy-agent][] | `http://proxy-server-over-tcp.com:3128`
|
||
| `https` | [http-proxy-agent][] | [https-proxy-agent][] | `https://proxy-server-over-tls.com:3129`
|
||
| `socks(v5)`| [socks-proxy-agent][] | [socks-proxy-agent][] | `socks://username:password@some-socks-proxy.com:9050` (username & password are optional)
|
||
| `socks5` | [socks-proxy-agent][] | [socks-proxy-agent][] | `socks5://username:password@some-socks-proxy.com:9050` (username & password are optional)
|
||
| `socks4` | [socks-proxy-agent][] | [socks-proxy-agent][] | `socks4://some-socks-proxy.com:9050`
|
||
| `pac` | [pac-proxy-agent][] | [pac-proxy-agent][] | `pac+http://www.example.com/proxy.pac`
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install proxy-agent
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
``` js
|
||
var http = require('http');
|
||
var ProxyAgent = require('proxy-agent');
|
||
|
||
// HTTP, HTTPS, or SOCKS proxy to use
|
||
var proxyUri = process.env.http_proxy || 'http://168.63.43.102:3128';
|
||
|
||
var opts = {
|
||
method: 'GET',
|
||
host: 'jsonip.org',
|
||
path: '/',
|
||
// this is the important part!
|
||
// If no proxyUri is specified, then https://www.npmjs.com/package/proxy-from-env
|
||
// is used to get the proxyUri.
|
||
agent: new ProxyAgent(proxyUri)
|
||
};
|
||
|
||
// the rest works just like any other normal HTTP request
|
||
http.get(opts, onresponse);
|
||
|
||
function onresponse (res) {
|
||
console.log(res.statusCode, res.headers);
|
||
res.pipe(process.stdout);
|
||
}
|
||
```
|
||
|
||
|
||
API
|
||
---
|
||
|
||
### new ProxyAgent(Object|String opts|uri)
|
||
|
||
Returns an `http.Agent` instance based off of the given proxy `opts` or URI
|
||
string. An LRU cache is used, so the same `http.Agent` instance will be
|
||
returned if identical args are passed in.
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
|
||
[http-proxy-agent]: https://github.com/TooTallNate/node-http-proxy-agent
|
||
[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent
|
||
[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent
|
||
[pac-proxy-agent]: https://github.com/TooTallNate/node-pac-proxy-agent
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- proxy-from-env@1.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License
|
||
|
||
Copyright (C) 2016-2018 Rob Wu <rob@robwu.nl>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- psl@1.8.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2017 Lupo Montero lupomontero@gmail.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- punycode@1.3.2
|
||
- punycode@2.1.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright Mathias Bynens <https://mathiasbynens.be/>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- q@1.5.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2009–2017 Kristopher Michael Kowal. All rights reserved.
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- q@2.0.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2009–2014 Kristopher Michael Kowal. All rights reserved.
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- qs@6.10.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
BSD 3-Clause License
|
||
|
||
Copyright (c) 2014, Nathan LaFreniere and other [contributors](https://github.com/ljharb/qs/graphs/contributors)
|
||
All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are met:
|
||
|
||
1. Redistributions of source code must retain the above copyright notice, this
|
||
list of conditions and the following disclaimer.
|
||
|
||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||
this list of conditions and the following disclaimer in the documentation
|
||
and/or other materials provided with the distribution.
|
||
|
||
3. Neither the name of the copyright holder nor the names of its
|
||
contributors may be used to endorse or promote products derived from
|
||
this software without specific prior written permission.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- qs@6.7.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2014 Nathan LaFreniere and other contributors.
|
||
All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are met:
|
||
* Redistributions of source code must retain the above copyright
|
||
notice, this list of conditions and the following disclaimer.
|
||
* Redistributions in binary form must reproduce the above copyright
|
||
notice, this list of conditions and the following disclaimer in the
|
||
documentation and/or other materials provided with the distribution.
|
||
* The names of any contributors may not be used to endorse or promote
|
||
products derived from this software without specific prior written
|
||
permission.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY
|
||
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
* * *
|
||
|
||
The complete list of contributors can be found at: https://github.com/hapijs/qs/graphs/contributors
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- query-string@6.14.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (http://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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- querystring@0.2.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2012 Irakli Gozalishvili. All rights reserved.
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- random-bytes@1.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2016 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- range-parser@1.2.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2012-2014 TJ Holowaychuk <tj@vision-media.ca>
|
||
Copyright (c) 2015-2016 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- raw-body@2.4.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2013-2014 Jonathan Ong <me@jongleberry.com>
|
||
Copyright (c) 2014-2015 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- readable-stream@1.1.14
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright Joyent, Inc. and other Node contributors. All rights reserved.
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- readable-stream@2.3.7
|
||
- readable-stream@3.6.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Node.js is licensed for use as follows:
|
||
|
||
"""
|
||
Copyright Node.js contributors. All rights reserved.
|
||
|
||
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.
|
||
"""
|
||
|
||
This license applies to parts of Node.js originating from the
|
||
https://github.com/joyent/node repository:
|
||
|
||
"""
|
||
Copyright Joyent, Inc. and other Node contributors. All rights reserved.
|
||
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.
|
||
"""
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- retry@0.12.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2011:
|
||
Tim Koschützki (tim@debuggable.com)
|
||
Felix Geisendörfer (felix@debuggable.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- rootpath@0.1.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
rootpath
|
||
========
|
||
|
||
Little helper to make node.js `require` relative to your project root
|
||
|
||
When working on a node.js project with subfolders you might find it difficult to remember the correct relative path to include a common module or library which is not published on npm.
|
||
Using this module you just need to remember your own project directory structure and make all `require` absolute to the project root directory
|
||
|
||
[](https://travis-ci.org/fabriziomoscon/rootpath)
|
||
|
||
install
|
||
-------
|
||
|
||
`npm install rootpath`
|
||
|
||
|
||
BEFORE
|
||
```JavaScript
|
||
// from $HOME_PROJECT/lib/math/
|
||
var myLib = require('../myLibrary');
|
||
var myUtils = require('../../utils/myUtils');
|
||
var myTest = require('../../test/myTest');
|
||
```
|
||
|
||
AFTER
|
||
```JavaScript
|
||
// from $HOME_PROJECT/lib/math/
|
||
|
||
require('rootpath')();
|
||
|
||
var myLib = require('lib/myLibrary');
|
||
var myUtils = require('utils/myUtils');
|
||
var myTest = require('test/myTest');
|
||
```
|
||
|
||
improvements
|
||
------------
|
||
|
||
Forks and pull requests are welcome. There is always a better way of achieving a goal. This project will benefit from the contribution of the community.
|
||
|
||
test
|
||
----
|
||
|
||
```bash
|
||
npm test
|
||
```
|
||
license
|
||
-------
|
||
|
||
MIT
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- rsa-pem-from-mod-exp@0.8.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014 Michael J. Ryan
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- safe-buffer@5.1.2
|
||
- safe-buffer@5.2.1
|
||
- typedarray-to-buffer@3.1.5
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) Feross Aboukhadijeh
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- safer-buffer@2.1.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2018 Nikita Skovoroda <chalkerx@gmail.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- sax@1.2.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The ISC License
|
||
|
||
Copyright (c) Isaac Z. Schlueter and Contributors
|
||
|
||
Permission to use, copy, modify, and/or distribute this software for any
|
||
purpose with or without fee is hereby granted, provided that the above
|
||
copyright notice and this permission notice appear in all copies.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
|
||
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||
|
||
====
|
||
|
||
`String.fromCodePoint` by Mathias Bynens used according to terms of MIT
|
||
License, as follows:
|
||
|
||
Copyright Mathias Bynens <https://mathiasbynens.be/>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- scmp@2.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2014, Sean Lavine
|
||
All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are met:
|
||
* Redistributions of source code must retain the above copyright
|
||
notice, this list of conditions and the following disclaimer.
|
||
* Redistributions in binary form must reproduce the above copyright
|
||
notice, this list of conditions and the following disclaimer in the
|
||
documentation and/or other materials provided with the distribution.
|
||
* Neither the name of the scmp project nor the
|
||
names of its contributors may be used to endorse or promote products
|
||
derived from this software without specific prior written permission.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
|
||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- send@0.17.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2012 TJ Holowaychuk
|
||
Copyright (c) 2014-2016 Douglas Christopher Wilson
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- serve-static@1.14.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2010 Sencha Inc.
|
||
Copyright (c) 2011 LearnBoost
|
||
Copyright (c) 2011 TJ Holowaychuk
|
||
Copyright (c) 2014-2016 Douglas Christopher Wilson
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- setprototypeof@1.1.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2015, Wes Todd
|
||
|
||
Permission to use, copy, modify, and/or distribute this software for any
|
||
purpose with or without fee is hereby granted, provided that the above
|
||
copyright notice and this permission notice appear in all copies.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
|
||
SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
|
||
OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
|
||
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- side-channel@1.0.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2019 Jordan Harband
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- signal-exit@3.0.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The ISC License
|
||
|
||
Copyright (c) 2015, Contributors
|
||
|
||
Permission to use, copy, modify, and/or distribute this software
|
||
for any purpose with or without fee is hereby granted, provided
|
||
that the above copyright notice and this permission notice
|
||
appear in all copies.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
|
||
OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE
|
||
LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
|
||
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
|
||
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
|
||
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- simple-swizzle@0.2.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 Josh Junon
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- slick@1.12.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# Slick
|
||
|
||
Slick is a standalone selector engine that is totally slick.
|
||
Slick is split in 2 components: the Finder and the Parser. The Finder's job is to find nodes on a webpage, the Parser's job is to create a javascript object representation of any css selector.
|
||
|
||
Slick allows you to:
|
||
|
||
* Create your own custom pseudo-classes
|
||
* Use the Parser by itself.
|
||
* Find nodes in XML documents.
|
||
|
||
---
|
||
|
||
## The Finder
|
||
|
||
Find nodes in the DOM
|
||
|
||
### `search` context for selector
|
||
|
||
Search this context for any nodes that match this selector.
|
||
|
||
Expects:
|
||
* selector: String or SelectorObject
|
||
* (**optional**) context: document or node or array of documents or nodes
|
||
* (**optional**) append: Array or Object with a push method
|
||
|
||
Returns: append argument or Array of 0 or more nodes
|
||
|
||
slick.search("#foo > bar.baz") → [<bar>, <bar>, <bar>]
|
||
slick.search("li > a", [<ol>, <ul>]) → [<a>, <a>, <a>]
|
||
slick.search("#foo > bar.baz", document, []) → [<bar>, <bar>, <bar>]
|
||
|
||
### `find` first in context with selector or null
|
||
|
||
Find the first node in document that matches selector or null if none are found.
|
||
|
||
Expects:
|
||
* selector: String or SelectorObject
|
||
* (**optional**) context: document or node or array of documents or nodes
|
||
|
||
Returns: Element or null
|
||
|
||
slick.find("#foo > bar.baz") → <bar>
|
||
slick.find("#does-not-exist", node) → null
|
||
|
||
### node `matches` selector?
|
||
|
||
Does this node match this selector?
|
||
|
||
Expects:
|
||
* node
|
||
* node, String or SelectorObject
|
||
|
||
Returns: true or false
|
||
|
||
slick.matches(<div class=rocks>, "div.rocks") → true
|
||
slick.matches(<div class=lame>, "div.rocks") → false
|
||
slick.matches(<div class=lame>, <div class=rocks>) → false
|
||
|
||
### context `contains` node?
|
||
|
||
Does this context contain this node? Is the context a parent of this node?
|
||
|
||
Expects:
|
||
* context: document or node
|
||
* node: node
|
||
|
||
Returns: true or false
|
||
|
||
slick.contains(<ul>, <li>) → true
|
||
slick.contains(<body>, <html>) → false
|
||
|
||
---
|
||
|
||
## The Parser
|
||
|
||
Parse a CSS selector string into a JavaScript object
|
||
|
||
### `parse` selector into object
|
||
|
||
Parse a CSS Selector String into a Selector Object.
|
||
|
||
Expects: String
|
||
|
||
Returns: SelectorObject
|
||
|
||
slick.parse("#foo > bar.baz") → SelectorObject
|
||
|
||
|
||
### format
|
||
|
||
### `#foo > bar.baz`
|
||
|
||
[[
|
||
{ "combinator":" ", "tag":"*", "id":"foo" },
|
||
{ "combinator":">", "tag":"bar", "classList": ["baz"], "classes": [{"value":"baz", "match": RegExp }]}
|
||
]]
|
||
|
||
### `h1, h2, ul > li, .things`
|
||
|
||
[
|
||
[{ "combinator":" ", "tag": "h1" }],
|
||
[{ "combinator":" ", "tag": "h2" }],
|
||
[{ "combinator":" ", "tag": "ul" }, { "combinator": ">", "tag": "li" }],
|
||
[{ "combinator":" ", "tag": "*", "classList": ["things"], "classes": [{"value": "things", "match": RegExp }] }]
|
||
]
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- smart-buffer@1.1.15
|
||
- socks@1.1.10
|
||
- socks@2.6.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2013 Josh Glazebrook
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- smart-buffer@4.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2013-2017 Josh Glazebrook
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- socks-proxy-agent@3.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
socks-proxy-agent
|
||
================
|
||
### A SOCKS proxy `http.Agent` implementation for HTTP and HTTPS
|
||
[](https://travis-ci.org/TooTallNate/node-socks-proxy-agent)
|
||
|
||
This module provides an `http.Agent` implementation that connects to a
|
||
specified SOCKS proxy server, and can be used with the built-in `http`
|
||
or `https` modules.
|
||
|
||
It can also be used in conjunction with the `ws` module to establish a WebSocket
|
||
connection over a SOCKS proxy. See the "Examples" section below.
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install socks-proxy-agent
|
||
```
|
||
|
||
|
||
Examples
|
||
--------
|
||
|
||
#### `http` module example
|
||
|
||
``` js
|
||
var url = require('url');
|
||
var http = require('http');
|
||
var SocksProxyAgent = require('socks-proxy-agent');
|
||
|
||
// SOCKS proxy to connect to
|
||
var proxy = process.env.socks_proxy || 'socks://127.0.0.1:9050';
|
||
console.log('using proxy server %j', proxy);
|
||
|
||
// HTTP endpoint for the proxy to connect to
|
||
var endpoint = process.argv[2] || 'http://nodejs.org/api/';
|
||
console.log('attempting to GET %j', endpoint);
|
||
var opts = url.parse(endpoint);
|
||
|
||
// create an instance of the `SocksProxyAgent` class with the proxy server information
|
||
var agent = new SocksProxyAgent(proxy);
|
||
opts.agent = agent;
|
||
|
||
http.get(opts, function (res) {
|
||
console.log('"response" event!', res.headers);
|
||
res.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
#### `https` module example
|
||
|
||
``` js
|
||
var url = require('url');
|
||
var https = require('https');
|
||
var SocksProxyAgent = require('socks-proxy-agent');
|
||
|
||
// SOCKS proxy to connect to
|
||
var proxy = process.env.socks_proxy || 'socks://127.0.0.1:9050';
|
||
console.log('using proxy server %j', proxy);
|
||
|
||
// HTTP endpoint for the proxy to connect to
|
||
var endpoint = process.argv[2] || 'https://encrypted.google.com/';
|
||
console.log('attempting to GET %j', endpoint);
|
||
var opts = url.parse(endpoint);
|
||
|
||
// create an instance of the `SocksProxyAgent` class with the proxy server information
|
||
// NOTE: the `true` second argument! Means to use TLS encryption on the socket
|
||
var agent = new SocksProxyAgent(proxy, true);
|
||
opts.agent = agent;
|
||
|
||
https.get(opts, function (res) {
|
||
console.log('"response" event!', res.headers);
|
||
res.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
#### `ws` WebSocket connection example
|
||
|
||
``` js
|
||
var WebSocket = require('ws');
|
||
var SocksProxyAgent = require('socks-proxy-agent');
|
||
|
||
// SOCKS proxy to connect to
|
||
var proxy = process.env.socks_proxy || 'socks://127.0.0.1:9050';
|
||
console.log('using proxy server %j', proxy);
|
||
|
||
// WebSocket endpoint for the proxy to connect to
|
||
var endpoint = process.argv[2] || 'ws://echo.websocket.org';
|
||
console.log('attempting to connect to WebSocket %j', endpoint);
|
||
|
||
// create an instance of the `SocksProxyAgent` class with the proxy server information
|
||
var agent = new SocksProxyAgent(proxy);
|
||
|
||
// initiate the WebSocket connection
|
||
var socket = new WebSocket(endpoint, { agent: agent });
|
||
|
||
socket.on('open', function () {
|
||
console.log('"open" event!');
|
||
socket.send('hello world');
|
||
});
|
||
|
||
socket.on('message', function (data, flags) {
|
||
console.log('"message" event! %j %j', data, flags);
|
||
socket.close();
|
||
});
|
||
```
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- socks-proxy-agent@5.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
socks-proxy-agent
|
||
================
|
||
### A SOCKS proxy `http.Agent` implementation for HTTP and HTTPS
|
||
[](https://github.com/TooTallNate/node-socks-proxy-agent/actions?workflow=Node+CI)
|
||
|
||
This module provides an `http.Agent` implementation that connects to a
|
||
specified SOCKS proxy server, and can be used with the built-in `http`
|
||
and `https` modules.
|
||
|
||
It can also be used in conjunction with the `ws` module to establish a WebSocket
|
||
connection over a SOCKS proxy. See the "Examples" section below.
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install socks-proxy-agent
|
||
```
|
||
|
||
|
||
Examples
|
||
--------
|
||
|
||
#### TypeScript example
|
||
|
||
```ts
|
||
import https from 'https';
|
||
import { SocksProxyAgent } from 'socks-proxy-agent';
|
||
|
||
const info = {
|
||
host: 'br41.nordvpn.com',
|
||
userId: 'your-name@gmail.com',
|
||
password: 'abcdef12345124'
|
||
};
|
||
const agent = new SocksProxyAgent(info);
|
||
|
||
https.get('https://jsonip.org', { agent }, (res) => {
|
||
console.log(res.headers);
|
||
res.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
#### `http` module example
|
||
|
||
```js
|
||
var url = require('url');
|
||
var http = require('http');
|
||
var SocksProxyAgent = require('socks-proxy-agent');
|
||
|
||
// SOCKS proxy to connect to
|
||
var proxy = process.env.socks_proxy || 'socks://127.0.0.1:1080';
|
||
console.log('using proxy server %j', proxy);
|
||
|
||
// HTTP endpoint for the proxy to connect to
|
||
var endpoint = process.argv[2] || 'http://nodejs.org/api/';
|
||
console.log('attempting to GET %j', endpoint);
|
||
var opts = url.parse(endpoint);
|
||
|
||
// create an instance of the `SocksProxyAgent` class with the proxy server information
|
||
var agent = new SocksProxyAgent(proxy);
|
||
opts.agent = agent;
|
||
|
||
http.get(opts, function (res) {
|
||
console.log('"response" event!', res.headers);
|
||
res.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
#### `https` module example
|
||
|
||
```js
|
||
var url = require('url');
|
||
var https = require('https');
|
||
var SocksProxyAgent = require('socks-proxy-agent');
|
||
|
||
// SOCKS proxy to connect to
|
||
var proxy = process.env.socks_proxy || 'socks://127.0.0.1:1080';
|
||
console.log('using proxy server %j', proxy);
|
||
|
||
// HTTP endpoint for the proxy to connect to
|
||
var endpoint = process.argv[2] || 'https://encrypted.google.com/';
|
||
console.log('attempting to GET %j', endpoint);
|
||
var opts = url.parse(endpoint);
|
||
|
||
// create an instance of the `SocksProxyAgent` class with the proxy server information
|
||
var agent = new SocksProxyAgent(proxy);
|
||
opts.agent = agent;
|
||
|
||
https.get(opts, function (res) {
|
||
console.log('"response" event!', res.headers);
|
||
res.pipe(process.stdout);
|
||
});
|
||
```
|
||
|
||
#### `ws` WebSocket connection example
|
||
|
||
``` js
|
||
var WebSocket = require('ws');
|
||
var SocksProxyAgent = require('socks-proxy-agent');
|
||
|
||
// SOCKS proxy to connect to
|
||
var proxy = process.env.socks_proxy || 'socks://127.0.0.1:1080';
|
||
console.log('using proxy server %j', proxy);
|
||
|
||
// WebSocket endpoint for the proxy to connect to
|
||
var endpoint = process.argv[2] || 'ws://echo.websocket.org';
|
||
console.log('attempting to connect to WebSocket %j', endpoint);
|
||
|
||
// create an instance of the `SocksProxyAgent` class with the proxy server information
|
||
var agent = new SocksProxyAgent(proxy);
|
||
|
||
// initiate the WebSocket connection
|
||
var socket = new WebSocket(endpoint, { agent: agent });
|
||
|
||
socket.on('open', function () {
|
||
console.log('"open" event!');
|
||
socket.send('hello world');
|
||
});
|
||
|
||
socket.on('message', function (data, flags) {
|
||
console.log('"message" event! %j %j', data, flags);
|
||
socket.close();
|
||
});
|
||
```
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- source-map@0.6.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2009-2011, Mozilla Foundation and contributors
|
||
All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are met:
|
||
|
||
* Redistributions of source code must retain the above copyright notice, this
|
||
list of conditions and the following disclaimer.
|
||
|
||
* Redistributions in binary form must reproduce the above copyright notice,
|
||
this list of conditions and the following disclaimer in the documentation
|
||
and/or other materials provided with the distribution.
|
||
|
||
* Neither the names of the Mozilla Foundation nor the names of project
|
||
contributors may be used to endorse or promote products derived from this
|
||
software without specific prior written permission.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- specificity@0.4.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
Copyright (c) 2016 Keegan Street and others
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- sprintf-js@1.0.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2007-2014, Alexandru Marasteanu <hello [at) alexei (dot] ro>
|
||
All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are met:
|
||
* Redistributions of source code must retain the above copyright
|
||
notice, this list of conditions and the following disclaimer.
|
||
* Redistributions in binary form must reproduce the above copyright
|
||
notice, this list of conditions and the following disclaimer in the
|
||
documentation and/or other materials provided with the distribution.
|
||
* Neither the name of this software nor the names of its contributors may be
|
||
used to endorse or promote products derived from this software without
|
||
specific prior written permission.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
|
||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- stack-trace@0.0.10
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2011 Felix Geisendörfer (felix@debuggable.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- statuses@1.5.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
|
||
Copyright (c) 2016 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- stream-events@1.0.5
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# stream-events
|
||
|
||
> Get an event when you're being sent data or asked for it.
|
||
|
||
## About
|
||
|
||
This is just a simple thing that tells you when `_read` and `_write` have been called, saving you the trouble of writing this yourself. You receive two events `reading` and `writing`-- no magic is performed.
|
||
|
||
This works well with [duplexify](https://github.com/mafintosh/duplexify) or lazy streams, so you can wait until you know you're being used as a stream to do something asynchronous, such as fetching an API token.
|
||
|
||
|
||
## Use
|
||
```sh
|
||
$ npm install --save stream-events
|
||
```
|
||
```js
|
||
var stream = require('stream')
|
||
var streamEvents = require('stream-events')
|
||
var util = require('util')
|
||
|
||
function MyStream() {
|
||
stream.Duplex.call(this)
|
||
streamEvents.call(this)
|
||
}
|
||
util.inherits(MyStream, stream.Duplex)
|
||
|
||
MyStream.prototype._read = function(chunk) {
|
||
console.log('_read called as usual')
|
||
this.push(new Buffer(chunk))
|
||
this.push(null)
|
||
}
|
||
|
||
MyStream.prototype._write = function() {
|
||
console.log('_write called as usual')
|
||
}
|
||
|
||
var stream = new MyStream
|
||
|
||
stream.on('reading', function() {
|
||
console.log('stream is being asked for data')
|
||
})
|
||
|
||
stream.on('writing', function() {
|
||
console.log('stream is being sent data')
|
||
})
|
||
|
||
stream.pipe(stream)
|
||
```
|
||
|
||
### Using with Duplexify
|
||
```js
|
||
var duplexify = require('duplexify')
|
||
var streamEvents = require('stream-events')
|
||
var fs = require('fs')
|
||
|
||
var dup = streamEvents(duplexify())
|
||
|
||
dup.on('writing', function() {
|
||
// do something async
|
||
dup.setWritable(/*writable stream*/)
|
||
})
|
||
|
||
fs.createReadStream('file').pipe(dup)
|
||
```
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- stream-shift@1.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2016 Mathias Buus
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- strict-uri-encode@2.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) Kevin Martensson <kevinmartensson@gmail.com> (github.com/kevva)
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- string_decoder@0.10.31
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright Joyent, Inc. and other Node 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- string_decoder@1.1.1
|
||
- string_decoder@1.3.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Node.js is licensed for use as follows:
|
||
|
||
"""
|
||
Copyright Node.js contributors. All rights reserved.
|
||
|
||
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.
|
||
"""
|
||
|
||
This license applies to parts of Node.js originating from the
|
||
https://github.com/joyent/node repository:
|
||
|
||
"""
|
||
Copyright Joyent, Inc. and other Node contributors. All rights reserved.
|
||
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.
|
||
"""
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- stripe@8.145.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (C) 2011 Ask Bjørn Hansen
|
||
Copyright (C) 2013 Stripe, Inc. (https://stripe.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- stubs@3.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# stubs
|
||
|
||
> It's a simple stubber.
|
||
|
||
## About
|
||
|
||
For when you don't want to write the same thing over and over to cache a method and call an override, then revert it, and blah blah.
|
||
|
||
|
||
## Use
|
||
```sh
|
||
$ npm install --save-dev stubs
|
||
```
|
||
```js
|
||
var mylib = require('./lib/index.js')
|
||
var stubs = require('stubs')
|
||
|
||
// make it a noop
|
||
stubs(mylib, 'create')
|
||
|
||
// stub it out
|
||
stubs(mylib, 'create', function() {
|
||
// calls this instead
|
||
})
|
||
|
||
// stub it out, but call the original first
|
||
stubs(mylib, 'create', { callthrough: true }, function() {
|
||
// call original method, then call this
|
||
})
|
||
|
||
// use the stub for a while, then revert
|
||
stubs(mylib, 'create', { calls: 3 }, function() {
|
||
// call this 3 times, then use the original method
|
||
})
|
||
```
|
||
|
||
|
||
## API
|
||
|
||
### stubs(object, method[[, opts], stub])
|
||
|
||
#### object
|
||
- Type: Object
|
||
|
||
#### method
|
||
- Type: String
|
||
|
||
Name of the method to stub.
|
||
|
||
#### opts
|
||
- (optional)
|
||
- Type: Object
|
||
|
||
##### opts.callthrough
|
||
- (optional)
|
||
- Type: Boolean
|
||
- Default: `false`
|
||
|
||
Call the original method as well as the stub (if a stub is provided).
|
||
|
||
##### opts.calls
|
||
- (optional)
|
||
- Type: Number
|
||
- Default: `0` (never revert)
|
||
|
||
Number of calls to allow the stub to receive until reverting to the original.
|
||
|
||
#### stub
|
||
- (optional)
|
||
- Type: Function
|
||
- Default: `function() {}`
|
||
|
||
This method is called in place of the original method. If `opts.callthrough` is `true`, this method is called *after* the original method is called as well.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- superagent-proxy@1.0.3
|
||
- superagent-proxy@2.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
superagent-proxy
|
||
================
|
||
### `Request#proxy(uri)` superagent extension
|
||
|
||
This module extends [`superagent`][superagent]'s `Request` class with
|
||
a `.proxy(uri)` function. This allows you to proxy the HTTP request through a
|
||
proxy of some kind.
|
||
|
||
It is backed by the [`proxy-agent`][proxy-agent] module, so see
|
||
[its README for more details][proxy-agent-readme].
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
Install with `npm`:
|
||
|
||
``` bash
|
||
$ npm install superagent-proxy
|
||
```
|
||
|
||
|
||
Example
|
||
-------
|
||
|
||
``` js
|
||
var request = require('superagent');
|
||
|
||
// extend with Request#proxy()
|
||
require('superagent-proxy')(request);
|
||
|
||
// HTTP, HTTPS, or SOCKS proxy to use
|
||
var proxy = process.env.http_proxy || 'http://168.63.43.102:3128';
|
||
|
||
request
|
||
.get(process.argv[2] || 'https://encrypted.google.com/')
|
||
.proxy(proxy)
|
||
.end(onresponse);
|
||
|
||
function onresponse (err, res) {
|
||
if (err) {
|
||
console.log(err);
|
||
} else {
|
||
console.log(res.status, res.headers);
|
||
console.log(res.body);
|
||
}
|
||
}
|
||
```
|
||
|
||
|
||
License
|
||
-------
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
[superagent]: https://github.com/visionmedia/superagent
|
||
[proxy-agent]: https://github.com/TooTallNate/node-proxy-agent
|
||
[proxy-agent-readme]: https://github.com/TooTallNate/node-proxy-agent/blob/master/README.md
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- superagent@3.8.3
|
||
- superagent@6.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014-2016 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- text-hex@1.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014-2015 Arnout Kazemier <opensource@3rd-Eden.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- thunkify@2.1.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
# thunkify
|
||
|
||
Turn a regular node function into one which returns a thunk,
|
||
useful for generator-based flow control such as [co](https://github.com/visionmedia/co).
|
||
|
||
## Installation
|
||
|
||
```
|
||
$ npm install thunkify
|
||
```
|
||
|
||
## Example
|
||
|
||
```js
|
||
var thunkify = require('thunkify');
|
||
var fs = require('fs');
|
||
|
||
var read = thunkify(fs.readFile);
|
||
|
||
read('package.json', 'utf8')(function(err, str){
|
||
|
||
});
|
||
```
|
||
|
||
# License
|
||
|
||
MIT
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- toidentifier@1.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2016 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- tough-cookie@2.5.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2015, Salesforce.com, Inc.
|
||
All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||
|
||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||
|
||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||
|
||
3. Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- triple-beam@1.3.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2017 winstonjs
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- tslib@1.14.1
|
||
- tslib@2.1.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) Microsoft Corporation.
|
||
|
||
Permission to use, copy, modify, and/or distribute this software for any
|
||
purpose with or without fee is hereby granted.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||
PERFORMANCE OF THIS SOFTWARE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- tsscmp@1.0.6
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2016
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- twilio@3.61.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (C) 2021, Twilio, Inc. <help@twilio.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- typedarray@0.0.6
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
/*
|
||
Copyright (c) 2010, Linden Research, Inc.
|
||
Copyright (c) 2012, Joshua Bell
|
||
|
||
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.
|
||
$/LicenseInfo$
|
||
*/
|
||
|
||
// Original can be found at:
|
||
// https://bitbucket.org/lindenlab/llsd
|
||
// Modifications by Joshua Bell inexorabletash@gmail.com
|
||
// https://github.com/inexorabletash/polyfill
|
||
|
||
// ES3/ES5 implementation of the Krhonos Typed Array Specification
|
||
// Ref: http://www.khronos.org/registry/typedarray/specs/latest/
|
||
// Date: 2011-02-01
|
||
//
|
||
// Variations:
|
||
// * Allows typed_array.get/set() as alias for subscripts (typed_array[])
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- uid-safe@2.1.5
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
|
||
Copyright (c) 2015-2017 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- universalify@0.1.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2017, Ryan Zimmerman <opensrc@ryanzim.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- unpipe@1.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- url@0.10.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright Joyent, Inc. and other Node 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- util-deprecate@1.0.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
(The MIT License)
|
||
|
||
Copyright (c) 2014 Nathan Rajlich <nathan@tootallnate.net>
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- utils-merge@1.0.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2013-2017 Jared Hanson
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- uuid@3.3.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2010-2016 Robert Kieffer and other 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- uuid@8.3.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2010-2020 Robert Kieffer and other 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- weak-map@1.0.5
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
`WeakMap` is a collection slated to be introduced to JavaScript with
|
||
EcmaScript 6. It provides a mapping from objects to values, but allows
|
||
any entry to be garbage collected if the key is provably lost.
|
||
|
||
In order for it to be possible that a key is provably lost, weak maps do
|
||
not provide a way to access the key list.
|
||
|
||
This is a Node Packaged Module (NPM) that provides a shim and patcher
|
||
for missing or broken WeakMap implementations suitable for use in
|
||
Node.js and browsers that provide the EcmaScript 5 property description
|
||
interfaces provided that it hosted by a CommonJS loader or bundler like
|
||
[Browserify][], [Montage][], [Mr][], or [Mop][].
|
||
|
||
[Browserify]: https://github.com/substack/node-browserify
|
||
[Montage]: https://github.com/montagejs/mr
|
||
[Mr]: https://github.com/montagejs/mr
|
||
[Mop]: https://github.com/montagejs/mop
|
||
|
||
```
|
||
npm install weak-map --save
|
||
```
|
||
|
||
```javascript
|
||
var WeakMap = require("weak-map");
|
||
var map = new WeakMap();
|
||
var key = {};
|
||
map.set(key, "Hello, World!");
|
||
map.get(key) === "Hello, World!";
|
||
key = null;
|
||
// "Hello, World!" may be collected
|
||
```
|
||
|
||
See [MDN][] for the API details.
|
||
|
||
[MDN]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap
|
||
|
||
At time of writing, prototype implementations of `WeakMap` exist in V8
|
||
and Spidermonkey. The prototype is available in Node.js v0.10 with the
|
||
`--harmony_collections` V8 option. In v0.8, it was available with
|
||
`--harmony_weakmaps`. The purpose of this package is to enable
|
||
dependees to use weak maps regardless of whether they are implemented by
|
||
the underlying engine, albeit in a way that leaks memory in some
|
||
non-obvious cases.
|
||
|
||
### Purpose and limitation
|
||
|
||
This shim depends on and modifies ECMAScript 5 property descriptor related
|
||
methods, `Object.defineProperty`, `Object.getOwnPropertyNames`,
|
||
`Object.isExtensible`, `Object.freeze`, and `Object.seal`.
|
||
|
||
In a nutshell, the WeakMap shim emulates a WeakMap by adding a hidden
|
||
property to the key that associates the weak map with the retained
|
||
object. The shim overrides the ECMAScript 5 methods to cover its tracks.
|
||
|
||
Consider a scenario that only includes a weak map, a key, and a corresponding
|
||
value through the weak map. With a proper `WeakMap`, built into the JavaScript
|
||
engine privy to the internals of the garbage collector, the `value` would be
|
||
retained either by the key or the weak map. If *either* the key or the weak map
|
||
are elligible for garbage collection, the value is elligible.
|
||
|
||
This is in contrast to to a plain `Map`. In a scenario with a map, a key, and a
|
||
value corresponding to the key through the map, neither the key nor the value
|
||
will be eligible for garbage collection until the map containing them is
|
||
elligible. Thus, if a map is used to establish a relationship between ephemeral
|
||
keys and values, it will accumulate garbage.
|
||
|
||
This shim does its best to approximate a proper `WeakMap` without an intimate
|
||
relationship with the garbage collector. In the same scenario, the value will
|
||
become elligible for garbage collection if the key is elligible. Unlike a proper
|
||
weak map, if the weak map shim becomes elligible for garbage collection but the
|
||
key is retained by something else, the value will be retained. In this scenario,
|
||
all operations of the weak map take constant time.
|
||
|
||
However, if the key is *frozen*, the weak map retains both the key and the value
|
||
and neither are elligible for collection until the weak map becomes elligible
|
||
itself. This scenario is unfortunately identical to the behavior of a `Map`.
|
||
Additionally, all operations of the weak map suffer linear time.
|
||
|
||
As stated by Mark Miller in the code:
|
||
|
||
> As with true WeakMaps, in this emulation, a key does not retain maps indexed by
|
||
> that key and (crucially) a map does not retain the keys it indexes. A map by
|
||
> itself also does not retain the values associated with that map.
|
||
>
|
||
> However, the values associated with a key in some map are retained so long as
|
||
> that key is retained and those associations are not overridden. For example,
|
||
> when used to support membranes, all values exported from a given membrane will
|
||
> live for the lifetime they would have had in the absence of an interposed
|
||
> membrane. Even when the membrane is revoked, all objects that would have been
|
||
> reachable in the absence of revocation will still be reachable, as far as the
|
||
> GC can tell, even though they will no longer be relevant to ongoing
|
||
> computation.
|
||
>
|
||
> The API implemented here is approximately the API as implemented
|
||
> in FF6.0a1 and agreed to by MarkM, Andreas Gal, and Dave Herman,
|
||
> rather than the offially approved proposal page.
|
||
>
|
||
> The first difference between the emulation here and that in FF6.0a1 is the
|
||
> presence of non enumerable `get___`, `has___`, `set___`, and `delete___`}
|
||
> methods on WeakMap instances to represent what would be the hidden internal
|
||
> properties of a primitive implementation. Whereas the FF6.0a1 WeakMap.prototype
|
||
> methods require their `this` to be a genuine WeakMap instance (i.e., an object
|
||
> of `[[Class]]` "WeakMap}), since there is nothing unforgeable about the
|
||
> pseudo-internal method names used here, nothing prevents these emulated
|
||
> prototype methods from being applied to non-WeakMaps with pseudo-internal
|
||
> methods of the same names.
|
||
>
|
||
> Another difference is that our emulated `WeakMap.prototype` is not itself a
|
||
> WeakMap. A problem with the current FF6.0a1 API is that WeakMap.prototype is
|
||
> itself a WeakMap providing ambient mutability and an ambient communications
|
||
> channel. Thus, if a WeakMap is already present and has this problem,
|
||
> repairES5.js wraps it in a safe wrappper in order to prevent access to this
|
||
> channel. (See PATCH_MUTABLE_FROZEN_WEAKMAP_PROTO in repairES5.js).
|
||
|
||
This refers to `repairES5.js` as provided by Google Caja.
|
||
|
||
### Origin and license
|
||
|
||
The canonical implementation of `WeakMap` exists in the Google Caja
|
||
Subversion repository at http://google-caja.googlecode.com/svn/trunk.
|
||
It was written by Mark S. Miller. It is released by Google with the
|
||
Apache 2.0 license. This package is maintained by Kris Kowal.
|
||
|
||
This work began with [Mark Miller’s proposal][Proposal] for `WeakMap` to ECMA’s
|
||
TC-39, where the JavaScript standard is developed.
|
||
|
||
[Proposal]: http://wiki.ecmascript.org/doku.php?id=harmony:weak_maps
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- websocket-driver@0.7.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2010-2020 James Coglan
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- websocket-extensions@0.1.4
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2014-2020 James Coglan
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- winston-transport@4.4.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2015 Charlie Robbins & the 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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- winston@3.3.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2010 Charlie Robbins
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- word-wrap@1.2.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2014-2017, Jon Schlinkert
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- write-file-atomic@3.0.3
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright (c) 2015, Rebecca Turner
|
||
|
||
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- xml2js@0.4.19
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
Copyright 2010, 2011, 2012, 2013. All rights reserved.
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- xmlbuilder2@2.4.1
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2019 Ozgur Ozcitak
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- xmlbuilder@13.0.2
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2013 Ozgur Ozcitak
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- xmlbuilder@9.0.7
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
The MIT License (MIT)
|
||
|
||
Copyright (c) 2013 Ozgur Ozcitak
|
||
|
||
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.
|
||
|
||
-----------
|
||
|
||
The following NPM packages may be included in this product:
|
||
|
||
- xregexp@2.0.0
|
||
|
||
These packages each contain the following license and notice below:
|
||
|
||
[XRegExp](http://xregexp.com/)
|
||
==============================
|
||
|
||
XRegExp provides augmented, extensible, cross-browser JavaScript regular expressions. You get new syntax and flags beyond what browsers support natively, along with a collection of utils to make your client-side grepping and parsing easier. XRegExp also frees you from worrying about pesky inconsistencies in cross-browser regex handling and the dubious `lastIndex` property.
|
||
|
||
XRegExp supports all native ES5 regular expression syntax. It's about 3.5 KB when minified and gzipped. It works with Internet Explorer 5.5+, Firefox 1.5+, Chrome, Safari 3+, and Opera 9.5+.
|
||
|
||
|
||
## Performance
|
||
|
||
XRegExp regular expressions compile to native RegExp objects, thus there is no performance difference when using XRegExp objects with native methods. There is a small performance cost when *compiling* XRegExps. If you want, however, you can use `XRegExp.cache` to avoid ever incurring the compilation cost for a given pattern more than once. Doing so can even lead to XRegExp being faster than native regexes in synthetic tests that repeatedly compile the same regex.
|
||
|
||
|
||
## Usage examples
|
||
|
||
~~~ js
|
||
// Using named capture and flag x (free-spacing and line comments)
|
||
var date = XRegExp('(?<year> [0-9]{4}) -? # year \n\
|
||
(?<month> [0-9]{2}) -? # month \n\
|
||
(?<day> [0-9]{2}) # day ', 'x');
|
||
|
||
// XRegExp.exec gives you named backreferences on the match result
|
||
var match = XRegExp.exec('2012-02-22', date);
|
||
match.day; // -> '22'
|
||
|
||
// It also includes optional pos and sticky arguments
|
||
var pos = 3, result = [];
|
||
while (match = XRegExp.exec('<1><2><3><4>5<6>', /<(\d+)>/, pos, 'sticky')) {
|
||
result.push(match[1]);
|
||
pos = match.index + match[0].length;
|
||
} // result -> ['2', '3', '4']
|
||
|
||
// XRegExp.replace allows named backreferences in replacements
|
||
XRegExp.replace('2012-02-22', date, '${month}/${day}/${year}'); // -> '02/22/2012'
|
||
XRegExp.replace('2012-02-22', date, function (match) {
|
||
return match.month + '/' + match.day + '/' + match.year;
|
||
}); // -> '02/22/2012'
|
||
|
||
// In fact, all XRegExps are RegExps and work perfectly with native methods
|
||
date.test('2012-02-22'); // -> true
|
||
|
||
// The *only* caveat is that named captures must be referred to using numbered backreferences
|
||
'2012-02-22'.replace(date, '$2/$3/$1'); // -> '02/22/2012'
|
||
|
||
// If you want, you can extend native methods so you don't have to worry about this
|
||
// Doing so also fixes numerous browser bugs in the native methods
|
||
XRegExp.install('natives');
|
||
'2012-02-22'.replace(date, '${month}/${day}/${year}'); // -> '02/22/2012'
|
||
'2012-02-22'.replace(date, function (match) {
|
||
return match.month + '/' + match.day + '/' + match.year;
|
||
}); // -> '02/22/2012'
|
||
date.exec('2012-02-22').day; // -> '22'
|
||
|
||
// Extract every other digit from a string using XRegExp.forEach
|
||
XRegExp.forEach('1a2345', /\d/, function (match, i) {
|
||
if (i % 2) this.push(+match[0]);
|
||
}, []); // -> [2, 4]
|
||
|
||
// Get numbers within <b> tags using XRegExp.matchChain
|
||
XRegExp.matchChain('1 <b>2</b> 3 <b>4 a 56</b>', [
|
||
XRegExp('(?is)<b>.*?</b>'),
|
||
/\d+/
|
||
]); // -> ['2', '4', '56']
|
||
|
||
// You can also pass forward and return specific backreferences
|
||
var html = '<a href="http://xregexp.com/">XRegExp</a>\
|
||
<a href="http://www.google.com/">Google</a>';
|
||
XRegExp.matchChain(html, [
|
||
{regex: /<a href="([^"]+)">/i, backref: 1},
|
||
{regex: XRegExp('(?i)^https?://(?<domain>[^/?#]+)'), backref: 'domain'}
|
||
]); // -> ['xregexp.com', 'www.google.com']
|
||
|
||
// XRegExp.union safely merges strings and regexes into a single pattern
|
||
XRegExp.union(['a+b*c', /(dogs)\1/, /(cats)\1/], 'i');
|
||
// -> /a\+b\*c|(dogs)\1|(cats)\2/i
|
||
~~~
|
||
|
||
These examples should give you the flavor of what's possible, but XRegExp has more syntax, flags, utils, options, and browser fixes that aren't shown here. You can even augment XRegExp's regular expression syntax with addons (see below) or write your own. See [xregexp.com](http://xregexp.com/) for more details.
|
||
|
||
|
||
## Addons
|
||
|
||
In browsers, you can either load addons individually, or bundle all addons together with XRegExp by loading `xregexp-all.js`. XRegExp's [npm](http://npmjs.org/) package uses `xregexp-all.js`, which means that the addons are always available when XRegExp is installed on the server using npm.
|
||
|
||
|
||
### XRegExp Unicode Base
|
||
|
||
In browsers, first include the Unicode Base script:
|
||
|
||
~~~ html
|
||
<script src="xregexp.js"></script>
|
||
<script src="addons/unicode/unicode-base.js"></script>
|
||
~~~
|
||
|
||
Then you can do this:
|
||
|
||
~~~ js
|
||
var unicodeWord = XRegExp('^\\p{L}+$');
|
||
unicodeWord.test('Русский'); // -> true
|
||
unicodeWord.test('日本語'); // -> true
|
||
unicodeWord.test('العربية'); // -> true
|
||
~~~
|
||
|
||
The base script adds `\p{Letter}` and its alias `\p{L}`, but other Unicode categories, scripts, blocks, and properties require addon packages. Try these next examples after additionally including `unicode-scripts.js`:
|
||
|
||
~~~ js
|
||
XRegExp('^\\p{Hiragana}+$').test('ひらがな'); // -> true
|
||
XRegExp('^[\\p{Latin}\\p{Common}]+$').test('Über Café.'); // -> true
|
||
~~~
|
||
|
||
XRegExp uses the Unicode 6.1 Basic Multilingual Plane.
|
||
|
||
|
||
### XRegExp.build
|
||
|
||
In browsers, first include the script:
|
||
|
||
~~~ html
|
||
<script src="xregexp.js"></script>
|
||
<script src="addons/build.js"></script>
|
||
~~~
|
||
|
||
You can then build regular expressions using named subpatterns, for readability and pattern reuse:
|
||
|
||
~~~ js
|
||
var time = XRegExp.build('(?x)^ {{hours}} ({{minutes}}) $', {
|
||
hours: XRegExp.build('{{h12}} : | {{h24}}', {
|
||
h12: /1[0-2]|0?[1-9]/,
|
||
h24: /2[0-3]|[01][0-9]/
|
||
}, 'x'),
|
||
minutes: /^[0-5][0-9]$/
|
||
});
|
||
|
||
time.test('10:59'); // -> true
|
||
XRegExp.exec('10:59', time).minutes; // -> '59'
|
||
~~~
|
||
|
||
Named subpatterns can be provided as strings or regex objects. A leading `^` and trailing unescaped `$` are stripped from subpatterns if both are present, which allows embedding independently useful anchored patterns. `{{…}}` tokens can be quantified as a single unit. Backreferences in the outer pattern and provided subpatterns are automatically renumbered to work correctly within the larger combined pattern. The syntax `({{name}})` works as shorthand for named capture via `(?<name>{{name}})`. Named subpatterns cannot be embedded within character classes.
|
||
|
||
See also: *[Creating Grammatical Regexes Using XRegExp.build](http://blog.stevenlevithan.com/archives/grammatical-patterns-xregexp-build)*.
|
||
|
||
|
||
### XRegExp.matchRecursive
|
||
|
||
In browsers, first include the script:
|
||
|
||
~~~ html
|
||
<script src="xregexp.js"></script>
|
||
<script src="addons/matchrecursive.js"></script>
|
||
~~~
|
||
|
||
You can then match recursive constructs using XRegExp pattern strings as left and right delimiters:
|
||
|
||
~~~ js
|
||
var str = '(t((e))s)t()(ing)';
|
||
XRegExp.matchRecursive(str, '\\(', '\\)', 'g');
|
||
// -> ['t((e))s', '', 'ing']
|
||
|
||
// Extended information mode with valueNames
|
||
str = 'Here is <div> <div>an</div></div> example';
|
||
XRegExp.matchRecursive(str, '<div\\s*>', '</div>', 'gi', {
|
||
valueNames: ['between', 'left', 'match', 'right']
|
||
});
|
||
/* -> [
|
||
{name: 'between', value: 'Here is ', start: 0, end: 8},
|
||
{name: 'left', value: '<div>', start: 8, end: 13},
|
||
{name: 'match', value: ' <div>an</div>', start: 13, end: 27},
|
||
{name: 'right', value: '</div>', start: 27, end: 33},
|
||
{name: 'between', value: ' example', start: 33, end: 41}
|
||
] */
|
||
|
||
// Omitting unneeded parts with null valueNames, and using escapeChar
|
||
str = '...{1}\\{{function(x,y){return y+x;}}';
|
||
XRegExp.matchRecursive(str, '{', '}', 'g', {
|
||
valueNames: ['literal', null, 'value', null],
|
||
escapeChar: '\\'
|
||
});
|
||
/* -> [
|
||
{name: 'literal', value: '...', start: 0, end: 3},
|
||
{name: 'value', value: '1', start: 4, end: 5},
|
||
{name: 'literal', value: '\\{', start: 6, end: 8},
|
||
{name: 'value', value: 'function(x,y){return y+x;}', start: 9, end: 35}
|
||
] */
|
||
|
||
// Sticky mode via flag y
|
||
str = '<1><<<2>>><3>4<5>';
|
||
XRegExp.matchRecursive(str, '<', '>', 'gy');
|
||
// -> ['1', '<<2>>', '3']
|
||
~~~
|
||
|
||
`XRegExp.matchRecursive` throws an error if it sees an unbalanced delimiter in the target string.
|
||
|
||
|
||
### XRegExp Prototype Methods
|
||
|
||
In browsers, first include the script:
|
||
|
||
~~~ html
|
||
<script src="xregexp.js"></script>
|
||
<script src="addons/prototypes.js"></script>
|
||
~~~
|
||
|
||
New XRegExp regexes then gain a collection of useful methods: `apply`, `call`, `forEach`, `globalize`, `xexec`, and `xtest`.
|
||
|
||
~~~ js
|
||
// To demonstrate the call method, let's first create the function we'll be using...
|
||
function filter(array, fn) {
|
||
var res = [];
|
||
array.forEach(function (el) {if (fn.call(null, el)) res.push(el);});
|
||
return res;
|
||
}
|
||
// Now we can filter arrays using functions and regexes
|
||
filter(['a', 'ba', 'ab', 'b'], XRegExp('^a')); // -> ['a', 'ab']
|
||
~~~
|
||
|
||
Native `RegExp` objects copied by `XRegExp` are augmented with any `XRegExp.prototype` methods. The following lines therefore work equivalently:
|
||
|
||
~~~ js
|
||
XRegExp('[a-z]', 'ig').xexec('abc');
|
||
XRegExp(/[a-z]/ig).xexec('abc');
|
||
XRegExp.globalize(/[a-z]/i).xexec('abc');
|
||
~~~
|
||
|
||
|
||
## Installation and usage
|
||
|
||
In browsers:
|
||
|
||
~~~ html
|
||
<script src="xregexp-min.js"></script>
|
||
~~~
|
||
|
||
Or, to bundle XRegExp with all of its addons:
|
||
|
||
~~~ html
|
||
<script src="xregexp-all-min.js"></script>
|
||
~~~
|
||
|
||
Using [npm](http://npmjs.org/):
|
||
|
||
~~~ bash
|
||
npm install xregexp
|
||
~~~
|
||
|
||
In [Node.js](http://nodejs.org/) and [CommonJS module](http://wiki.commonjs.org/wiki/Modules) loaders:
|
||
|
||
~~~ js
|
||
var XRegExp = require('xregexp').XRegExp;
|
||
~~~
|
||
|
||
|
||
### Running tests on the server with npm
|
||
|
||
~~~ bash
|
||
npm install -g qunit # needed to run the tests
|
||
npm test # in the xregexp root
|
||
~~~
|
||
|
||
If XRegExp was not installed using npm, just open `tests/index.html` in your browser.
|
||
|
||
|
||
## &c
|
||
|
||
**Lookbehind:** A [collection of short functions](https://gist.github.com/2387872) is available that makes it easy to simulate infinite-length leading lookbehind.
|
||
|
||
|
||
## Changelog
|
||
|
||
* Releases: [Version history](http://xregexp.com/history/).
|
||
* Upcoming: [Milestones](https://github.com/slevithan/XRegExp/issues/milestones), [Roadmap](https://github.com/slevithan/XRegExp/wiki/Roadmap).
|
||
|
||
|
||
## About
|
||
|
||
XRegExp and addons copyright 2007-2012 by [Steven Levithan](http://stevenlevithan.com/).
|
||
|
||
Tools: Unicode range generators by [Mathias Bynens](http://mathiasbynens.be/). Source file concatenator by [Bjarke Walling](http://twitter.com/walling).
|
||
|
||
Prior art: `XRegExp.build` inspired by [Lea Verou](http://lea.verou.me/)'s [RegExp.create](http://lea.verou.me/2011/03/create-complex-regexps-more-easily/). `XRegExp.union` inspired by [Ruby](http://www.ruby-lang.org/). XRegExp's syntax extensions come from Perl, .NET, etc.
|
||
|
||
All code released under the [MIT License](http://mit-license.org/).
|
||
|
||
Fork me to show support, fix, and extend.
|
||
|
||
-----------
|
||
|
||
This file was generated with generate-license-file! https://www.npmjs.com/package/generate-license-file |