postalsys / mailauth

Command line utility and a Node.js library for email authentication
Other
126 stars 10 forks source link

docs: added note regarding `getDmarcRecord` having two arguments #29

Closed titanism closed 1 year ago

CLAassistant commented 1 year ago

CLA assistant check
All committers have signed the CLA.

titanism commented 1 year ago

Not signing that @andris9 but feel free to merge or author yourself the same commit

titanism commented 1 year ago

@andris9 I made two other small changes, this PR is ready - or you can commit yourself and author the same.

1) getDmarcRecord has two arguments domain and an optional resolver which defaults to dns.resolve 2) docs example is missing await in const dmarcRecord = await getDmarcRecord 3) docs is missing that the function getDmarcRecord returns false if no results exist