UNPKG

10.1 kBMarkdownView Raw
1<!-- TITLE/ -->
2
3# domain-browser
4
5<!-- /TITLE -->
6
7<!-- BADGES/ -->
8
9<span class="badge-githubworkflow"><a href="https://github.com/bevry/domain-browser/actions?query=workflow%3Abevry" title="View the status of this project's GitHub Workflow: bevry"><img src="https://github.com/bevry/domain-browser/workflows/bevry/badge.svg" alt="Status of the GitHub Workflow: bevry" /></a></span>
10<span class="badge-npmversion"><a href="https://npmjs.org/package/domain-browser" title="View this project on NPM"><img src="https://img.shields.io/npm/v/domain-browser.svg" alt="NPM version" /></a></span>
11<span class="badge-npmdownloads"><a href="https://npmjs.org/package/domain-browser" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/domain-browser.svg" alt="NPM downloads" /></a></span>
12<br class="badge-separator" />
13<span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
14<span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/bevry" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span>
15<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
16<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
17<span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
18<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
19<span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
20<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
21<br class="badge-separator" />
22<span class="badge-discord"><a href="https://discord.gg/nQuXddV7VP" title="Join this project's community on Discord"><img src="https://img.shields.io/discord/1147436445783560193?logo=discord&amp;label=discord" alt="Discord server badge" /></a></span>
23<span class="badge-twitch"><a href="https://www.twitch.tv/balupton" title="Join this project's community on Twitch"><img src="https://img.shields.io/twitch/status/balupton?logo=twitch" alt="Twitch community badge" /></a></span>
24
25<!-- /BADGES -->
26
27<!-- DESCRIPTION/ -->
28
29Node's domain module for the web browser. This is merely an evented try...catch with the same API as node, nothing more.
30
31<!-- /DESCRIPTION -->
32
33<!-- INSTALL/ -->
34
35## Install
36
37### [npm](https://npmjs.com "npm is a package manager for javascript")
38
39- Install: `npm install --save domain-browser`
40- Import: `import * as pkg from ('domain-browser')`
41- Require: `const pkg = require('domain-browser')`
42
43### [jspm](https://jspm.io "Native ES Modules CDN")
44
45``` html
46<script type="module">
47 import * as pkg from '//dev.jspm.io/domain-browser@5.7.0'
48</script>
49```
50### [Editions](https://editions.bevry.me "Editions are the best way to produce and consume packages you care about.")
51
52This package is published with the following editions:
53- `domain-browser` aliases `domain-browser/source/index.js`
54- `domain-browser/source/index.js` is ES5 source code for web browsers and [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
55
56<!-- /INSTALL -->
57
58<!-- HISTORY/ -->
59
60## History
61
62[Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/domain-browser/blob/HEAD/HISTORY.md#files)
63
64<!-- /HISTORY -->
65
66<!-- BACKERS/ -->
67
68## Backers
69
70### Code
71
72[Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/domain-browser/blob/HEAD/CONTRIBUTING.md#files)
73
74#### Authors
75
76- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
77
78#### Maintainers
79
80- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
81
82#### Contributors
83
84- [Benjamin Lupton](https://github.com/balupton) — [view contributions](https://github.com/bevry/domain-browser/commits?author=balupton "View the GitHub contributions of Benjamin Lupton on repository bevry/domain-browser")
85- [Bogdan Chadkin](https://github.com/TrySound) — [view contributions](https://github.com/bevry/domain-browser/commits?author=TrySound "View the GitHub contributions of Bogdan Chadkin on repository bevry/domain-browser")
86- [Evan Solomon](https://github.com/evansolomon) — [view contributions](https://github.com/bevry/domain-browser/commits?author=evansolomon "View the GitHub contributions of Evan Solomon on repository bevry/domain-browser")
87- [Guy Bedford](https://github.com/guybedford) — [view contributions](https://github.com/bevry/domain-browser/commits?author=guybedford "View the GitHub contributions of Guy Bedford on repository bevry/domain-browser")
88- [James Halliday](https://github.com/substack) — [view contributions](https://github.com/bevry/domain-browser/commits?author=substack "View the GitHub contributions of James Halliday on repository bevry/domain-browser")
89- [Sammy filly](https://github.com/X-oss-byte) — [view contributions](https://github.com/bevry/domain-browser/commits?author=X-oss-byte "View the GitHub contributions of Sammy filly on repository bevry/domain-browser")
90
91### Finances
92
93<span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
94<span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/bevry" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span>
95<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
96<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
97<span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
98<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
99<span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
100<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
101
102#### Sponsors
103
104- [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher
105- [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.
106- [Codecov](https://codecov.io) — Empower developers with tools to improve code quality and testing.
107- [Poonacha Medappa](https://poonachamedappa.com)
108- [Rob Morris](https://github.com/Rob-Morris)
109- [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.
110- [Syntax](https://syntax.fm) — Syntax Podcast
111
112#### Donors
113
114- [Andrew Nesbitt](https://nesbitt.io)
115- [Armen Mkrtchian](https://mogoni.dev)
116- [Balsa](https://balsa.com)
117- [Chad](https://opencollective.com/chad8)
118- [Codecov](https://codecov.io)
119- [dr.dimitru](https://veliovgroup.com)
120- [Elliott Ditman](https://elliottditman.com)
121- [entroniq](https://gitlab.com/entroniq)
122- [GitHub](https://github.com/about)
123- [Hunter Beast](https://cryptoquick.com)
124- [Jean-Luc Geering](https://github.com/jlgeering)
125- [Michael Duane Mooring](https://mdm.cc)
126- [Michael Harry Scepaniak](https://michaelscepaniak.com)
127- [Mohammed Shah](https://github.com/smashah)
128- [Mr. Henry](https://mrhenry.be)
129- [Nermal](https://arjunaditya.vercel.app)
130- [Pleo](https://pleo.io)
131- [Poonacha Medappa](https://poonachamedappa.com)
132- [Rob Morris](https://github.com/Rob-Morris)
133- [Robert de Forest](https://github.com/rdeforest)
134- [Sentry](https://sentry.io)
135- [ServieJS](https://github.com/serviejs)
136- [Skunk Team](https://skunk.team)
137- [Syntax](https://syntax.fm)
138- [WriterJohnBuck](https://github.com/WriterJohnBuck)
139
140<!-- /BACKERS -->
141
142<!-- LICENSE/ -->
143
144## License
145
146Unless stated otherwise all works are:
147
148- Copyright &copy; [Benjamin Lupton](https://balupton.com)
149
150and licensed under:
151
152- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)
153
154<!-- /LICENSE -->