effx
API reference@effx/compilerextensions

http-contract

API reference for @effx/compiler/extensions/http-contract

http-contract.ts overview

Exports Grouped by Category

utils

HttpContractData

Transport-specific IR payload. References remain importable symbols, not serialized Schema ASTs.

Signature

declare const HttpContractData: Schema.Struct<{
  readonly root: Schema.String
  readonly group: Schema.String
  readonly params: Schema.optionalKey<
    Schema.Struct<{
      readonly module: Schema.String
      readonly export: Schema.String
      readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
    }>
  >
  readonly paramsKeys: Schema.optionalKey<Schema.$Array<Schema.String>>
  readonly query: Schema.optionalKey<
    Schema.Struct<{
      readonly module: Schema.String
      readonly export: Schema.String
      readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
    }>
  >
  readonly headers: Schema.optionalKey<
    Schema.Struct<{
      readonly module: Schema.String
      readonly export: Schema.String
      readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
    }>
  >
  readonly headersKeys: Schema.optionalKey<Schema.$Array<Schema.String>>
  readonly payload: Schema.optionalKey<
    Schema.Struct<{
      readonly module: Schema.String
      readonly export: Schema.String
      readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
    }>
  >
  readonly payloadIsQuery: Schema.optionalKey<Schema.Boolean>
  readonly success: Schema.Struct<{
    readonly module: Schema.String
    readonly export: Schema.String
    readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
  }>
  readonly status: Schema.optionalKey<Schema.Int>
  readonly mediaType: Schema.optionalKey<Schema.String>
  readonly responseHeaders: Schema.optionalKey<
    Schema.Struct<{
      readonly module: Schema.String
      readonly export: Schema.String
      readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
    }>
  >
  readonly conditional: Schema.Boolean
  readonly middleware: Schema.$Array<
    Schema.Struct<{
      readonly module: Schema.String
      readonly export: Schema.String
      readonly member: Schema.optionalKey<Schema.String>
    }>
  >
  readonly securityMiddleware: Schema.optionalKey<
    Schema.$Array<
      Schema.Struct<{
        readonly module: Schema.String
        readonly export: Schema.String
        readonly member: Schema.optionalKey<Schema.String>
      }>
    >
  >
  readonly metadata: Schema.optionalKey<
    Schema.Struct<{
      readonly annotator: Schema.optionalKey<
        Schema.Struct<{
          readonly module: Schema.String
          readonly export: Schema.String
          readonly member: Schema.optionalKey<Schema.String>
        }>
      >
      readonly operationId: Schema.optionalKey<Schema.String>
      readonly summary: Schema.optionalKey<Schema.String>
      readonly description: Schema.optionalKey<Schema.String>
      readonly tags: Schema.optionalKey<Schema.$Array<Schema.String>>
      readonly commandIdentity: Schema.optionalKey<
        Schema.Struct<{
          readonly module: Schema.String
          readonly export: Schema.String
          readonly member: Schema.optionalKey<Schema.String>
        }>
      >
    }>
  >
}>

HttpContractData (type alias)

Signature

type HttpContractData = typeof HttpContractData.Type

httpContractExtension

Signature

declare const httpContractExtension: Extension

foldkit

API reference for @effx/compiler/extensions/foldkit

http-group

API reference for @effx/compiler/extensions/http-group

On this page

http-contract.ts overviewExports Grouped by CategoryutilsHttpContractDataHttpContractData (type alias)httpContractExtension