Skip to main content

Interface: StreamConsumer

Defined in: packages/contracts/src/permissions/table.ts:377

A JetStream consumer a module reads.

Properties​

module​

readonly module: "identity" | "audit" | "governance" | "trust" | "issuance" | "verification" | "vault" | "signing" | "e-services" | "provisioning"

Defined in: packages/contracts/src/permissions/table.ts:385

The module that reads it. Its host may read the consumer and check that the stream and the consumer are configured as declared; it may not create or change either (see STREAM_DECLARER).


name​

readonly name: string

Defined in: packages/contracts/src/permissions/table.ts:379

Durable consumer name.


reads?​

readonly optional reads?: readonly ("request.platform.identity.principal.resolve.v1" | "request.platform.identity.me.get.v1" | "request.*.identity.subject.create.v1" | "request.*.identity.subject.get.v1" | "request.platform.identity.bootstrap.apply.v1" | "request.*.identity.person.create.v1" | "request.*.identity.person.get.v1" | "request.*.identity.person.invite.v1" | "request.*.identity.grant.create.v1" | "request.*.identity.grant.revoke.v1" | "request.*.identity.grant.list.v1" | "event.*.identity.grant.revoked.v1" | "event.*.*.audit.recorded.v1" | "event.platform.gateway.audit.recorded.v1" | "event.platform.gateway-admin.audit.recorded.v1" | "event.platform.bootstrap.audit.recorded.v1" | "request.*.governance.accreditation.apply.v1" | "request.*.governance.accreditation.admit.v1" | "request.*.governance.accreditation.publish.v1" | "request.*.governance.accreditation.get.v1" | "request.*.governance.accreditation.list.v1" | "request.platform.governance.anchor.converge.v1" | "event.*.governance.accreditation.admitted.v1" | "event.*.governance.accreditation.publication-approved.v1" | "request.*.trust.entity-statement.list.v1" | "request.*.trust.entity-statement.preview.v1" | "event.*.trust.entity-statement.published.v1" | "request.*.issuance.identifier.create.v1" | "request.*.issuance.identifier.get.v1" | "request.*.issuance.identifier.list.v1" | "request.*.issuance.identifier.preview.v1" | "request.*.issuance.identifier.publish.v1" | "request.*.issuance.identifier.update.v1" | "request.platform.provisioning.agent.converge.v1" | "request.platform.issuance.registry.probe.v1" | "request.platform.issuance.identifier.converge.v1" | "request.platform.trust.key-store.probe.v1" | "request.platform.issuance.identifier.resolve.v1" | "request.platform.identity.root-sign-in.get.v1" | "event.*.issuance.identifier.requested.v1" | "event.*.provisioning.placement.changed.v1" | "event.*.issuance.identifier.published.v1")[]

Defined in: packages/contracts/src/permissions/table.ts:392

The captured contracts this consumer is filtered to. Absent, it reads everything the stream captures, which is right for a stream with one reader. A stream two modules exchange events on gives each consumer its own half, so that neither is delivered the event it published itself. Each entry must be one of the stream's captures.