bun-whois-parser
v1.1.6
Published
A Bun whois parser
Downloads
23
Maintainers
Readme
Bun whois parser
(WIP) Not tested to ALL tlds
You can see the regex-patterns in patterns.js
(Big thanks to @moneals for writing most of the regex <3)
How to use it?
I recommend to use a tool to lookup whois, just like whois-light. Then you can simply pass the raw data into the parser just like this:
const { lookup } = require("whois-light")
const parser = require('bun-whois-parser')
const url = 'https://caamillo.it' // url to lookup
try {
const raw = await lookup(url) // lookup using whois-light
const parsed = await parser(raw, url) // url not required
console.log(parsed) // Your parsed whois!
} catch(err) {
// Handle lookup error
console.error(err)
}
Parameters
| Key | Description | Default | |-----------|----------------------------------------------------------|-----------| | data | whois raw data | undefined | | url? | fetched url/domain | undefined | | toISO? | parse all dates into ISO format | true | | optimize? | dangerous, read more in the "Optimize Parameter" section | false |
Response
Basically a json with the following description:
| Key | Description | |--------------------|--------------------------| | tld | tld name | | available | is the domain available? | | domainName | domain name | | registrar | whois registrar | | updatedDate | whost updated date | | creationDate | whois creation date | | expirationDate | whois expiration date | | status | whois status |
How does it work?
- Makes an object of all the hard coded TLD regex pattern (you can see them inside
patterns.js
).
// Example of regex-pattern, useful to make your regex
{
tld: 'tld-name',
regex: {
domainName: 'domain-name-regex',
registrar: 'registrar-regex',
updatedDate: 'updated-date-regex',
creationDate: 'creation-date-regex',
expirationDate: 'expiration-date-regex',
status: 'status-regex'
},
etc: {
notFound: 'regex-to-see-if-available',
dateFormat: 'the-format-to-parse-date',
rateLimited: 'custom-whois-message-when-many-requests'
}
}
// ALL the fields and sub-fields (regex || domainName) are optional except for `tld` attribute
- If a field or a sub-field is not given, they will be overrided by default-pattern
patterns[0]
, so it's top-to-down. - Now checks the
tlds.json
file and if a tld is not given, then it makes an empty pattern object (with default-pattern active) - Your parse it's ready sir!
Optimize Parameter
Use the algorithm avoiding adding all the tlds that are not found in patterns.js
.
This parameter is setted to off by default, but you may would use it if you know what tlds you will work with.
Features
- Fastest whois-parser (
~0,02s
with optimize parameter,~0,04s
without), - Offline and sync,
- Domain name auto detection,
- Domain name wrapper from URL
TODOs
- [x] Parse dates using
dateFormat
attribute - [ ] Better
tlds.json
- [ ] Use
rateLimited
- [ ] Make tests to run whois in various tlds to search which one can't be parsed
Please consider to collaborate on that. The more regex-patterns we write, the better it is.