ssb-gathering-schema

    1.2.4 • Public • Published

    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,
      progenitor: MessageId  // (optional) the thing that spawned this gathering
      mentions: Array,       // (optional) people to notify
      recps: Array           // (optional) private recipients
    }

    mentions / recps entries each a FeedId, or a 'link' object: { link: FeedId, name: String}

    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
      },
      recps: Array          // (optional)
    }

    recps entries each a FeedId, or a 'link' object: { link: FeedId, name: String}

    attendee (type: about)

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

    recps entries each a FeedId, or a 'link' object: { link: FeedId, name: String}

    Install

    npm i ssb-gathering-schema

    DownloadsWeekly Downloads

    3

    Version

    1.2.4

    License

    AGPL-3.0

    Unpacked Size

    14 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar