effx
API reference@effx/compiler

Collected

API reference for @effx/compiler/Collected

Collected.ts overview

Exports Grouped by Category

utils

EmitMode

Signature

declare const EmitMode: Schema.Literals<readonly ["contract", "handlers", "all"]>

EmitMode (type alias)

Signature

type EmitMode = EmitModeData

GroupBinding

Backend-owned static references, deliberately outside the semantic IR. @internal

Signature

declare const GroupBinding: Schema.Struct<{
  readonly group: Schema.Struct<{
    readonly module: Schema.String
    readonly export: Schema.String
    readonly member: Schema.optionalKey<Schema.String>
  }>
  readonly handlers: Schema.Struct<{
    readonly module: Schema.String
    readonly export: Schema.String
    readonly member: Schema.optionalKey<Schema.String>
  }>
  readonly handlersTypeParameters: Schema.$Array<
    Schema.Struct<{
      readonly name: Schema.String
      readonly constraint: Schema.String
      readonly default: Schema.String
      readonly references: Schema.$Array<
        Schema.Struct<{
          readonly ref: Schema.Struct<{
            readonly module: Schema.String
            readonly export: Schema.String
            readonly member: Schema.optionalKey<Schema.String>
          }>
          readonly where: Schema.Literals<readonly ["constraint", "default"]>
          readonly start: Schema.Finite
          readonly end: Schema.Finite
        }>
      >
    }>
  >
  readonly guardsTypeParameters: Schema.$Array<
    Schema.Struct<{
      readonly name: Schema.String
      readonly constraint: Schema.String
      readonly default: Schema.String
      readonly references: Schema.$Array<
        Schema.Struct<{
          readonly ref: Schema.Struct<{
            readonly module: Schema.String
            readonly export: Schema.String
            readonly member: Schema.optionalKey<Schema.String>
          }>
          readonly where: Schema.Literals<readonly ["constraint", "default"]>
          readonly start: Schema.Finite
          readonly end: Schema.Finite
        }>
      >
    }>
  >
  readonly guards: Schema.optionalKey<
    Schema.Struct<{
      readonly module: Schema.String
      readonly export: Schema.String
      readonly member: Schema.optionalKey<Schema.String>
    }>
  >
  readonly guardFor: Schema.optionalKey<
    Schema.Struct<{
      readonly module: Schema.String
      readonly export: Schema.String
      readonly member: Schema.optionalKey<Schema.String>
    }>
  >
}>

GroupBinding (type alias)

Signature

type GroupBinding = typeof GroupBinding.Type

GroupBindingReference

A type reference inside a mirrored constraint/default, addressed by its source span.

Signature

declare const GroupBindingReference: Schema.Struct<{
  readonly ref: Schema.Struct<{
    readonly module: Schema.String
    readonly export: Schema.String
    readonly member: Schema.optionalKey<Schema.String>
  }>
  readonly where: Schema.Literals<readonly ["constraint", "default"]>
  readonly start: Schema.Finite
  readonly end: Schema.Finite
}>

GroupBindingReference (type alias)

Signature

type GroupBindingReference = typeof GroupBindingReference.Type

GroupBindingTypeParameter

One mirrored type parameter of a handler factory; constraint/default keep their source syntax.

Signature

declare const GroupBindingTypeParameter: Schema.Struct<{
  readonly name: Schema.String
  readonly constraint: Schema.String
  readonly default: Schema.String
  readonly references: Schema.$Array<
    Schema.Struct<{
      readonly ref: Schema.Struct<{
        readonly module: Schema.String
        readonly export: Schema.String
        readonly member: Schema.optionalKey<Schema.String>
      }>
      readonly where: Schema.Literals<readonly ["constraint", "default"]>
      readonly start: Schema.Finite
      readonly end: Schema.Finite
    }>
  >
}>

GroupBindingTypeParameter (type alias)

Signature

type GroupBindingTypeParameter = typeof GroupBindingTypeParameter.Type

HttpApiGroupInventory (interface)

Inventory keyed by the same canonical symbol as HttpGroup.rootSymbol.

Signature

export interface HttpApiGroupInventory {
  readonly root: SymbolRef
  readonly group: string
  readonly endpoints: ReadonlyArray<string>
}

Naming

Signature

declare const Naming: Schema.Struct<{ readonly problemIdentifier: Schema.optionalKey<Schema.String> }>

Naming (type alias)

Signature

type Naming = NamingData

ProjectConfig

Signature

declare const ProjectConfig: Schema.Struct<{
  readonly naming: Schema.optionalKey<Schema.Struct<{ readonly problemIdentifier: Schema.optionalKey<Schema.String> }>>
  readonly tsconfigPath: Schema.String
  readonly entry: Schema.optionalKey<Schema.$Array<Schema.String>>
  readonly outDir: Schema.optionalKey<Schema.String>
  readonly projectRoot: Schema.optionalKey<Schema.String>
  readonly target: Schema.optionalKey<Schema.Literals<readonly ["effect-4.0"]>>
  readonly emit: Schema.optionalKey<Schema.Literals<readonly ["contract", "handlers", "all"]>>
  readonly strictAccess: Schema.optionalKey<Schema.Boolean>
  readonly lift: Schema.optionalKey<
    Schema.Struct<{
      readonly projections: Schema.optionalKey<
        Schema.$Array<
          Schema.Struct<{
            readonly key: Schema.Struct<{
              readonly module: Schema.String
              readonly export: Schema.String
              readonly member: Schema.optionalKey<Schema.String>
            }>
            readonly hook: Schema.Struct<{
              readonly module: Schema.String
              readonly export: Schema.String
              readonly member: Schema.optionalKey<Schema.String>
            }>
          }>
        >
      >
      readonly rules: Schema.$Array<
        Schema.TaggedUnion<{
          readonly SuccessWrapper: Schema.TaggedStruct<
            "SuccessWrapper",
            {
              readonly callee: Schema.Struct<{
                readonly module: Schema.String
                readonly export: Schema.String
                readonly member: Schema.optionalKey<Schema.String>
              }>
              readonly schema: Schema.optionalKey<
                Schema.Struct<{
                  readonly module: Schema.String
                  readonly export: Schema.String
                  readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
                }>
              >
              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.optionalKey<Schema.Literal<true>>
              readonly status: Schema.optionalKey<Schema.Int>
            }
          >
          readonly NoSchemaSuccess: Schema.TaggedStruct<
            "NoSchemaSuccess",
            {
              readonly callee: Schema.Struct<{
                readonly module: Schema.String
                readonly export: Schema.String
                readonly member: Schema.optionalKey<Schema.String>
              }>
            }
          >
          readonly ProblemRegistry: Schema.TaggedStruct<
            "ProblemRegistry",
            {
              readonly response: Schema.Struct<{
                readonly module: Schema.String
                readonly export: Schema.String
                readonly member: Schema.optionalKey<Schema.String>
              }>
              readonly union: Schema.Struct<{
                readonly module: Schema.String
                readonly export: Schema.String
                readonly member: Schema.optionalKey<Schema.String>
              }>
              readonly registry: Schema.Struct<{
                readonly module: Schema.String
                readonly export: Schema.String
                readonly member: Schema.optionalKey<Schema.String>
              }>
            }
          >
          readonly Metadata: Schema.TaggedStruct<
            "Metadata",
            {
              readonly callee: Schema.Struct<{
                readonly module: Schema.String
                readonly export: Schema.String
                readonly member: Schema.optionalKey<Schema.String>
              }>
              readonly annotator: Schema.Struct<{
                readonly module: Schema.String
                readonly export: Schema.String
                readonly member: Schema.optionalKey<Schema.String>
              }>
              readonly positional: Schema.$Array<Schema.Literals<readonly ["summary", "description"]>>
            }
          >
          readonly Access: Schema.TaggedStruct<
            "Access",
            {
              readonly callee: Schema.Struct<{
                readonly module: Schema.String
                readonly export: Schema.String
                readonly member: Schema.optionalKey<Schema.String>
              }>
              readonly apply: Schema.optionalKey<
                Schema.Struct<{
                  readonly module: Schema.String
                  readonly export: Schema.String
                  readonly member: Schema.optionalKey<Schema.String>
                }>
              >
              readonly annotator: Schema.Struct<{
                readonly module: Schema.String
                readonly export: Schema.String
                readonly member: Schema.optionalKey<Schema.String>
              }>
              readonly arguments: Schema.TaggedUnion<{
                readonly Object: Schema.TaggedStruct<
                  "Object",
                  {
                    readonly fields: Schema.$Array<
                      Schema.Struct<{
                        readonly name: Schema.String
                        readonly kind: Schema.Literals<readonly ["string", "strings", "boolean"]>
                        readonly required: Schema.Boolean
                        readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>
                      }>
                    >
                  }
                >
                readonly Positional: Schema.TaggedStruct<
                  "Positional",
                  {
                    readonly params: Schema.$Array<
                      Schema.Struct<{
                        readonly name: Schema.String
                        readonly kind: Schema.Literals<readonly ["string", "strings", "boolean"]>
                        readonly required: Schema.Boolean
                        readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>
                      }>
                    >
                  }
                >
              }>
              readonly resolver: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
              readonly emit: Schema.Struct<{
                readonly exposure: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
                readonly acceptedCredentials: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
                readonly principalKinds: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
                readonly capabilities: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
                readonly requirements: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
                readonly concealment: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
                readonly decisionTime: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
              }>
            }
          >
        }>
      >
      readonly names: Schema.$Record<
        Schema.String,
        Schema.Struct<{
          readonly module: Schema.String
          readonly export: Schema.String
          readonly member: Schema.optionalKey<Schema.String>
        }>
      >
      readonly emptyInput: Schema.optionalKey<
        Schema.Struct<{
          readonly module: Schema.String
          readonly export: Schema.String
          readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
        }>
      >
      readonly output: Schema.Struct<{ readonly module: Schema.String }>
    }>
  >
}>

ProjectConfig (type alias)

Signature

type ProjectConfig = typeof ProjectConfig.Type

TargetProfile

Signature

declare const TargetProfile: Schema.Literals<readonly ["effect-4.0"]>

TargetProfile (type alias)

Signature

type TargetProfile = TargetProfileData

API reference

Generated from JSDoc by @effect/docgen

CompilerFault

API reference for @effx/compiler/CompilerFault

On this page

Collected.ts overviewExports Grouped by CategoryutilsEmitModeEmitMode (type alias)GroupBindingGroupBinding (type alias)GroupBindingReferenceGroupBindingReference (type alias)GroupBindingTypeParameterGroupBindingTypeParameter (type alias)HttpApiGroupInventory (interface)NamingNaming (type alias)ProjectConfigProjectConfig (type alias)TargetProfileTargetProfile (type alias)