Variable relation`Const`

relation: <SourceSchema extends AnyNoContext, TargetSchema extends AnyNoContext>(
opts: EchoRelationSchemaOptions<SourceSchema, TargetSchema>,
) => <Self extends Any>(
self: Self,
) => Type.Relation<Type<Self>, Type<SourceSchema>, Type<TargetSchema>>

Factory function to create an ECHO relation schema. Adds relation metadata annotations to an Effect schema.

Type declaration

- <SourceSchema extends AnyNoContext, TargetSchema extends AnyNoContext>(
  opts: EchoRelationSchemaOptions<SourceSchema, TargetSchema>,
  ): <Self extends Any>(
  self: Self,
  ) => Type.Relation<Type<Self>, Type<SourceSchema>, Type<TargetSchema>>
- Type Parameters
  - SourceSchema extends AnyNoContext
  - TargetSchema extends AnyNoContext
  Parameters
  - opts: EchoRelationSchemaOptions<SourceSchema, TargetSchema>
  Returns <Self extends Any>(
  self: Self,
  ) => Type.Relation<Type<Self>, Type<SourceSchema>, Type<TargetSchema>>

Example

const WorksFor = Schema.Struct({
  role: Schema.String,
}).pipe(Type.relation({
  typename: 'com.example.type.works-for',
  version: '0.1.0',
  source: Person,
  target: Company,
}));

Variable relationConst

Type declaration

Type Parameters

Parameters

Returns <Self extends Any>( self: Self,) => Type.Relation<Type<Self>, Type<SourceSchema>, Type<TargetSchema>>

Example

Settings

Variable relation`Const`

Returns <Self extends Any>(
self: Self,
) => Type.Relation<Type<Self>, Type<SourceSchema>, Type<TargetSchema>>