effx
API reference@effx/ir

Node

API reference for @effx/ir/Node

Node.ts overview

Exports Grouped by Category

utils

CapabilityNode (type alias)

Signature

type CapabilityNode = typeof Node.cases.Capability.Type

ExposureNode (type alias)

Signature

type ExposureNode = typeof Node.cases.Exposure.Type

ExtensionNode (type alias)

Signature

type ExtensionNode = typeof Node.cases.Extension.Type

FocusNode (type alias)

Signature

type FocusNode = typeof Node.cases.Focus.Type

HttpGroupNode (type alias)

Signature

type HttpGroupNode = typeof Node.cases.HttpGroup.Type

HttpMethod

Signature

declare const HttpMethod: Schema.Literals<readonly ["GET", "POST", "PUT", "PATCH", "DELETE"]>

HttpMethod (type alias)

Signature

type HttpMethod = typeof HttpMethod.Type

ModelNode (type alias)

Signature

type ModelNode = typeof Node.cases.Model.Type

Node

Signature

declare const Node: Schema.TaggedUnion<{
  readonly Schema: Schema.TaggedStruct<
    "Schema",
    {
      readonly id: Schema.brand<Schema.String, "effx/StableId">
      readonly ref: Schema.Struct<{
        readonly module: Schema.String
        readonly export: Schema.String
        readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
      }>
    }
  >
  readonly Model: Schema.TaggedStruct<
    "Model",
    {
      readonly id: Schema.brand<Schema.String, "effx/StableId">
      readonly name: Schema.String
      readonly schema: Schema.Struct<{
        readonly module: Schema.String
        readonly export: Schema.String
        readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
      }>
      readonly table: Schema.optionalKey<Schema.String>
      readonly views: Schema.$Array<
        Schema.Struct<{
          readonly name: Schema.String
          readonly schema: Schema.Struct<{
            readonly module: Schema.String
            readonly export: Schema.String
            readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
          }>
        }>
      >
    }
  >
  readonly Service: Schema.TaggedStruct<
    "Service",
    {
      readonly id: Schema.brand<Schema.String, "effx/StableId">
      readonly name: Schema.String
      readonly symbol: Schema.Struct<{
        readonly module: Schema.String
        readonly export: Schema.String
        readonly member: Schema.optionalKey<Schema.String>
      }>
    }
  >
  readonly Operation: Schema.TaggedStruct<
    "Operation",
    {
      readonly id: Schema.brand<Schema.String, "effx/StableId">
      readonly name: Schema.String
      readonly kind: Schema.Literals<readonly ["Query", "Command"]>
      readonly input: Schema.Struct<{
        readonly module: Schema.String
        readonly export: Schema.String
        readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
      }>
      readonly success: Schema.Struct<{
        readonly module: Schema.String
        readonly export: Schema.String
        readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
      }>
      readonly errors: Schema.Struct<{
        readonly values: Schema.$Array<
          Schema.Struct<{
            readonly module: Schema.String
            readonly export: Schema.String
            readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
          }>
        >
        readonly inferred: Schema.Boolean
      }>
      readonly requirements: Schema.Struct<{
        readonly values: Schema.$Array<Schema.brand<Schema.String, "effx/StableId">>
        readonly inferred: Schema.Boolean
      }>
      readonly binding: Schema.optionalKey<Schema.Literal<"external">>
      readonly handler: Schema.optionalKey<
        Schema.Struct<{
          readonly module: Schema.String
          readonly export: Schema.String
          readonly member: Schema.optionalKey<Schema.String>
        }>
      >
    }
  >
  readonly HttpGroup: Schema.TaggedStruct<
    "HttpGroup",
    {
      readonly id: Schema.brand<Schema.String, "effx/StableId">
      readonly root: Schema.String
      readonly rootSymbol: Schema.optionalKey<
        Schema.Struct<{
          readonly module: Schema.String
          readonly export: Schema.String
          readonly member: Schema.optionalKey<Schema.String>
        }>
      >
      readonly group: Schema.String
      readonly title: Schema.optionalKey<Schema.String>
      readonly description: Schema.optionalKey<Schema.String>
      readonly displayName: Schema.optionalKey<Schema.String>
    }
  >
  readonly Capability: Schema.TaggedStruct<
    "Capability",
    {
      readonly id: Schema.brand<Schema.String, "effx/StableId">
      readonly name: Schema.String
      readonly resource: Schema.brand<Schema.String, "effx/StableId">
      readonly focus: Schema.optionalKey<Schema.brand<Schema.String, "effx/StableId">>
    }
  >
  readonly Focus: Schema.TaggedStruct<
    "Focus",
    {
      readonly id: Schema.brand<Schema.String, "effx/StableId">
      readonly root: Schema.brand<Schema.String, "effx/StableId">
      readonly path: Schema.$Array<Schema.String>
    }
  >
  readonly Exposure: Schema.TaggedStruct<
    "Exposure",
    {
      readonly id: Schema.brand<Schema.String, "effx/StableId">
      readonly operation: Schema.brand<Schema.String, "effx/StableId">
      readonly transport: Schema.Union<
        readonly [
          Schema.TaggedStruct<
            "http",
            {
              readonly method: Schema.Literals<readonly ["GET", "POST", "PUT", "PATCH", "DELETE"]>
              readonly path: Schema.String
            }
          >,
          Schema.TaggedStruct<"rpc", { readonly name: Schema.String }>,
          Schema.TaggedStruct<"cli", { readonly command: Schema.$Array<Schema.String> }>
        ]
      >
    }
  >
  readonly Extension: Schema.TaggedStruct<
    "Extension",
    {
      readonly id: Schema.brand<Schema.String, "effx/StableId">
      readonly extension: Schema.String
      readonly tag: Schema.String
      readonly data: Schema.Codec<Schema.Json, Schema.Json, never, never>
    }
  >
}>

Node (type alias)

Signature

type Node = typeof Node.Type

OperationKind

Signature

declare const OperationKind: Schema.Literals<readonly ["Query", "Command"]>

OperationKind (type alias)

Signature

type OperationKind = typeof OperationKind.Type

OperationNode (type alias)

Signature

type OperationNode = typeof Node.cases.Operation.Type

SchemaNode (type alias)

Signature

type SchemaNode = typeof Node.cases.Schema.Type

ServiceNode (type alias)

Signature

type ServiceNode = typeof Node.cases.Service.Type

Transport

Signature

declare const Transport: Schema.Union<
  readonly [
    Schema.TaggedStruct<
      "http",
      {
        readonly method: Schema.Literals<readonly ["GET", "POST", "PUT", "PATCH", "DELETE"]>
        readonly path: Schema.String
      }
    >,
    Schema.TaggedStruct<"rpc", { readonly name: Schema.String }>,
    Schema.TaggedStruct<"cli", { readonly command: Schema.$Array<Schema.String> }>
  ]
>

Transport (type alias)

Signature

type Transport = typeof Transport.Type

View

Signature

declare const View: Schema.Struct<{
  readonly name: Schema.String
  readonly schema: Schema.Struct<{
    readonly module: Schema.String
    readonly export: Schema.String
    readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
  }>
}>

View (type alias)

Signature

type View = typeof View.Type

Edge

API reference for @effx/ir/Edge

Refs

API reference for @effx/ir/Refs

On this page

Node.ts overviewExports Grouped by CategoryutilsCapabilityNode (type alias)ExposureNode (type alias)ExtensionNode (type alias)FocusNode (type alias)HttpGroupNode (type alias)HttpMethodHttpMethod (type alias)ModelNode (type alias)NodeNode (type alias)OperationKindOperationKind (type alias)OperationNode (type alias)SchemaNode (type alias)ServiceNode (type alias)TransportTransport (type alias)ViewView (type alias)