is-my-ssb-valid

Build message validators for scuttlebutt using JSON schema. Uses is-my-json-valid under the hood

Example usage

1const Validator = require('is-my-ssb-valid')
2const profileSchema = require('ssb-profile/spec/profile/schema')
3
4const isProfile = Validator(profileSchema)

1const A = {
2  //....
3}
4
5isProfile(A)
6// => true | false
7
8console.log(isProfile.errors)
9// => null | [Error]
10
11console.log(isProfile.errorsString)
12// => '' | 'data.type is required'  (example)

1const pull = require('pull-stream')
2
3pull(
4  sbot.messagesByType({ type: 'profile/person', reverse: true }),
5  pull.filter(isProfile),
6  pull.take(50),
7  pull.collect((err, profileUpdates) => {
8    // ...
9  })
10)

API

Validator(schema) => isValid

where:

• schema Object is a JSON schema
• extras Array (optional) is an Array of additional custom validation functions.
  • These will be run after the schema-based validation, and are expected to either return true (no problem) or an Error (a problem) was found.
  • any error returned be added to the isValid.errors and isValid.errorsString for you (see below)

isValid(msg) => Boolean

where msg can be any of

• a full message a "full message" of form { key, value, timestamp }
• just the value of a message (msg.value)
• just the content field of a message (msg.value.content)

If the last message tested came back invalid ("false"), then you can also check out the specific errors:

• isValid.errors will be populated with those errors
• isValid.errorsString will be populated with a (crudely) flattened version in case you need a String