0.0.33 • Published 1 year ago
nostr-relay-inspector v0.0.33
nostr-relay-inspector
Library for inspecting nostr relays.
Presently alpha, result objects and API are prone to change. Docs will be published shortly after beta
Install
npm
npm install nostr-relay-inspector
yarn
yarn add nostr-relay-inspector
Usage
import { Inspector } from 'nostr-relay-inspector`
let inspect;
//pass websocket reference
inspect = new Inspector('wss://nostr.sandwich.farm');
//...do some things with the relay
inspect = new Inspector(relay);
inspect
.on('open', (e, result) => {
console.log('unprocessed', result);
})
.on('complete', (e, result) => {
console.log('processed relay', result);
})
.run()
Example
checkRelay(relay){
let inspect = new Inspector(relay)
inspect
.on('complete', inspector => {
if( inspector.result instanceof Object)
doSomething(inspector.result)
else
doSomething({})
})
.on('error', inspector => doSomething(inspector.result, true))
.run()
.catch( console.error )
}
doSomething(result, error){
if(!error)
alert(`${relay.url} - Connect?: ${relay.check.connect ? 'yes' : 'no'}, Read?: ${relay.check.read ? 'yes' : 'no'}, Write?: ${relay.check.write ? 'yes' : 'no'}`
else
alert(`there was an error on ${result.url}`)
}
checkRelay('wss://nostr.damus.io')
Todo
- Alpha release
- Return collated result object, requires minor refactor
- Clean up the namespace
- Write tests
- Docs
0.0.23
1 year ago
0.0.24
1 year ago
0.0.25
1 year ago
0.0.30
1 year ago
0.0.31
1 year ago
0.0.32
1 year ago
0.0.33
1 year ago
0.0.26
1 year ago
0.0.27
1 year ago
0.0.28
1 year ago
0.0.29
1 year ago
0.0.22
1 year ago
0.0.21
1 year ago
0.0.20
1 year ago
0.0.19
1 year ago
0.0.18
1 year ago
0.0.17
1 year ago
0.0.16
1 year ago
0.0.15
1 year ago
0.0.14
1 year ago
0.0.13
1 year ago
0.0.12
1 year ago
0.0.11
1 year ago
0.0.10
1 year ago
0.0.9
1 year ago
0.0.7
1 year ago
0.0.6
1 year ago
0.0.5
1 year ago
0.0.4
1 year ago
0.0.3
1 year ago
0.0.2
1 year ago
0.0.1
1 year ago