Documentation / @super-line/core / InspectorContract

Variable: InspectorContract

const InspectorContract: object

Defined in: packages/core/src/inspector.ts:225

The fixed, library-owned contract describing the inspector surface. Identical for every super-line app, so it is NOT merged into the user's contract — inbound dispatch routes an inspector connection against this instead, which keeps the user's RoleOf<C> clean.

Type Declaration

roles

readonly roles: object

roles.inspector

readonly inspector: object

roles.inspector.clientToServer

readonly clientToServer: object

roles.inspector.clientToServer.getConn

readonly getConn: object

roles.inspector.clientToServer.getConn.input

readonly input: StandardSchemaV1<{ id: string; }, { id: string; }>

roles.inspector.clientToServer.getConn.output

readonly output: StandardSchemaV1<ConnView, ConnView>

roles.inspector.clientToServer.getContract

readonly getContract: object

roles.inspector.clientToServer.getContract.input

readonly input: StandardSchemaV1<void, void>

roles.inspector.clientToServer.getContract.output

readonly output: StandardSchemaV1<InspectedContract, InspectedContract>

roles.inspector.clientToServer.getNode

readonly getNode: object

roles.inspector.clientToServer.getNode.input

readonly input: StandardSchemaV1<void, void>

roles.inspector.clientToServer.getNode.output

readonly output: StandardSchemaV1<NodeView, NodeView>

roles.inspector.clientToServer.getTopology

readonly getTopology: object

roles.inspector.clientToServer.getTopology.input

readonly input: StandardSchemaV1<void, void>

roles.inspector.clientToServer.getTopology.output

readonly output: StandardSchemaV1<NodeStat[], NodeStat[]>

roles.inspector.clientToServer.listCollections

readonly listCollections: object

roles.inspector.clientToServer.listCollections.input

readonly input: StandardSchemaV1<void, void>

roles.inspector.clientToServer.listCollections.output

readonly output: StandardSchemaV1<CollectionInfo[], CollectionInfo[]>

roles.inspector.clientToServer.listConnections

readonly listConnections: object

roles.inspector.clientToServer.listConnections.input

readonly input: StandardSchemaV1<void, void>

roles.inspector.clientToServer.listConnections.output

readonly output: StandardSchemaV1<ConnDescriptor[], ConnDescriptor[]>

roles.inspector.clientToServer.queryCollection

readonly queryCollection: object

roles.inspector.clientToServer.queryCollection.input

readonly input: StandardSchemaV1<object & CollectionQuery, object & CollectionQuery>

roles.inspector.clientToServer.queryCollection.output

readonly output: StandardSchemaV1<unknown[], unknown[]>

roles.inspector.serverToClient

readonly serverToClient: object

roles.inspector.serverToClient.events

readonly events: object

roles.inspector.serverToClient.events.payload

readonly payload: StandardSchemaV1<InspectorEnvelope, InspectorEnvelope>

roles.inspector.serverToClient.events.subscribe

readonly subscribe: true = true