iya-sts
    Preparing search index...

    Class export=

    The Shared Signals model: the tables the family builds its rows from, and the holding of what it answers and sends.

    Index
    • The members several event types share (caep: CAEP 1.0 section 2's four; risc: the three RISC gives the one type that has them).

      Parameters

      • id: string

        caep or risc

      Returns Json[]

      the members; a copy

    • SSF's complex subject: { format, memberName, cite, members }.

      Returns Json

      a copy

    • The delivery methods: { method, name, what, cite }.

      Returns Json[]

      the rows; a copy

    • One document: { id, cite, members, list }.

      Parameters

      • id: string

        the document's id, such as stream-configuration

      Returns Json

      the document

    • Every err value the model declares, with the document defining it.

      Returns Json[]

      [{ code, cite }]

    • Every event type, in catalogue order: { uri, family, name, subject, subjectFormats?, deprecated?, members, what, cite }, each member { name, required, type, values?, what, cite? }.

      Returns Json[]

      the rows; a copy

    • Whether a JSON value is one of the types a member may take.

      Parameters

      • value: unknown

        the value

      • types: string[]

        from the model: string, integer, number, boolean, array, object or any

      Returns boolean

      true when it is

    • Every subject identifier format: { format, person, what, example, cite, members }, example as JSON text, each member { name, required, check, types }.

      Returns Json[]

      the rows; a copy

    • One list's values: credential-types or stream-statuses.

      Parameters

      • id: string

        the list's id

      Returns string[]

      the values; a copy

    • The stream configuration members one party supplies (SSF 1.0 section 8.1.1), in the model's order.

      Parameters

      • by: string

        transmitter or receiver

      Returns string[]

      the member names

    • What a document carries that the model does not allow: a member a closed document does not name, a named member of a type it does not allow, and a required member missing. Empty when the document is the model's.

      Parameters

      • id: string

        the document's id

      • value: Json

        the document

      • Optionaloptions: Json

        open: a member the model does not name is not a problem (a partner's document, which may extend the specification); partial: a required member may be missing (a request carrying only what it changes); supplier: every member but stream_id must be one that party supplies (SSF 1.0 section 8.1.1)

      Returns string[]

      one sentence per problem

    • Whether an err value is one the model does not declare.

      Parameters

      • code: string

        the err value

      Returns boolean

      true when the model does not declare it