@pty-server/protocol
v0.1.0
Published
Shared wire/JSON protocol types for pty-server (ptys server and clients).
Readme
@pty-server/protocol
Shared wire protocol for ptys: TypeScript types, TypeBox JSON schemas, the protocol version, and generated API-document builders.
Install
npm install @pty-server/protocolExports
import {
PROTOCOL_VERSION,
SessionSchema,
type Session,
createOpenApiDocument,
createAsyncApiDocument,
} from "@pty-server/protocol";*Schemaexports are TypeBox schemas for HTTP and WebSocket payloads.- The matching TypeScript types are exported alongside their schemas.
PROTOCOL_VERSIONidentifies the terminal-stream protocol version.createOpenApiDocumentandcreateAsyncApiDocumentgenerate the HTTP and WebSocket API documents used by ptys.
See the repository’s HTTP API and terminal-stream API documents for endpoint details.
