git ssb

0+

mixmix / ssb-gathering-schema



Tree: 02a191f8e7ff6bee2149956d58dce0c939e7b1c8

Files: 02a191f8e7ff6bee2149956d58dce0c939e7b1c8 / README.md

1133 bytesRaw

ssb-gathering-schema

Usage

var { isGathering, isGatheringUpdate, isAttendee } = require('ssb-gathering-schema')

isGathering(msg)
// => true

Schemas

schemas describe the content section of messages

gathering

{
  type: gathering
}

gathering-update (type: about)

Updates to the details of a gathering are about messages with some / all of the following attributes. (everything but type and about are optional)

{
  type: 'about'
  about: MessageId,     // gathering
  title: String,        // (optional)
  description: String,  // (optional)
  location: String,     // (optional)
  startDateTime: {      // (optional)
    epoch: Integer,       // unix time
    tz: TimeZoneString,   // *
    bias: Integer         // * ?
    silent: Boolean       // * ?
  },
  image: {              // (optional)
    link: BlobId,
    name: String,
    size: Integer,
    type: MimeType
  }
}

attendee (type: about)

```js { type: 'about', about: MessageId, // gathering attendee: { link: FeedId // can be about another person! remove: true // (optional) } }

Built with git-ssb-web