Skip to main content

Module libs

Module libs 

Source
Expand description

TypeSpec Library Modules

This module contains the TypeSpec standard library extensions, ported from the TypeScript packages under @typespec/*.

Each sub-module represents a library that provides:

  • .tsp type definitions (decorator declarations, models, scalars, etc.)
  • Rust decorator implementations
  • Validation logic
  • Diagnostic definitions

Currently ported libraries:

  • compiler - TypeSpec std decorators (@doc, @tag, @key, @error, @format, paging, examples, etc.)
  • http - @typespec/http: HTTP protocol decorators and types
  • xml - @typespec/xml: XML serialization decorators and types
  • streams - @typespec/streams: Stream protocol types
  • sse - @typespec/sse: Server-Sent Events types
  • events - @typespec/events: Event system decorators
  • rest - @typespec/rest: REST API decorators and resource types
  • protobuf - @typespec/protobuf: Protocol Buffers types and decorators
  • openapi - @typespec/openapi: OpenAPI annotations and types
  • versioning - @typespec/versioning: API versioning decorators

Utility modules:

  • uri_template - RFC 6570 URI template parser
  • status_codes - HTTP status code validation
  • content_types - HTTP content type resolution
  • json_schema - @typespec/json-schema: JSON Schema decorators and types
  • openapi3 - @typespec/openapi3: OpenAPI 3.x emitter decorators and types

Modules§

compiler
TypeSpec Standard Library Decorators
content_types
HTTP Content Type Utilities
decorator_macros
Macros for generating repetitive decorator accessor patterns
events
@typespec/events - Event System Decorators
http
@typespec/http - HTTP Protocol Decorators and Types
json_schema
@typespec/json-schema - JSON Schema Decorators and Types
openapi
@typespec/openapi - OpenAPI Decorators and Types
openapi3
@typespec/openapi3 - OpenAPI 3.x Emitter Decorators and Types
protobuf
@typespec/protobuf - Protocol Buffers Types and Decorators
rest
@typespec/rest - REST API Decorators and Resource Types
sse
@typespec/sse - Server-Sent Events Types
status_codes
HTTP Status Code Utilities
streams
@typespec/streams - Stream Protocol Types
uri_template
URI Template Parser
versioning
@typespec/versioning - API Versioning Decorators and Types
xml
@typespec/xml - XML Serialization Decorators and Types