Type alias ProtocolRuleSet

Type declaration

• [key: string]: any

• Optional $actions?: ProtocolActionRule[]

• Optional $encryption?: ProtocolPathEncryption

  Encryption setting for objects that are in this protocol path.

• Optional $role?: boolean

  If true, this marks a record as a role that may used within a context. The recipient of a $role record may invoke their role by setting protocolRole property to the protocol path of the $role record.

• Optional $size?: {
      max?: number;
      min?: number;
  }

  If $size is set, the record size in bytes must be within the limits.

  • Optional max?: number

  • Optional min?: number

• Optional $tags?: {
      $allowUndefinedTags?: boolean;
      $requiredTags?: string[];
      [key: string]: any;
  }

  If $tags is set, the record must conform to the tag rules.

  • [key: string]: any

  • Optional $allowUndefinedTags?: boolean

    allow properties other than those explicitly listed. defaults to false

  • Optional $requiredTags?: string[]

    array of required tags