Collection

Defined in: packages/core/src/cms.ts:120

Defines a collection with its loading, transformation, and validation pipeline.

Example

const postsCollection: Collection<PostLoadSchema, PostSchema, {}, FileSystem> = {
  loadingSchema: PostLoadSchema,
  transformedSchema: PostSchema,
  loader: loadPostsFromFS,
  transformer: transformPost,
  validator: validatePost,
  relations: {}
};

Type Parameters

TLoadSchema

TLoadSchema extends AnySchema

Schema for the raw loaded data

TTransformSchema

TTransformSchema extends AnySchema

Schema for the transformed data

TRelations

TRelations extends Partial<Record<keyof Schema.Schema.Type<TTransformSchema>, CollectionRelation>>

Map of field names to their collection relations

TLoaderDeps

TLoaderDeps

Dependencies required by the loader

TTransformerDeps

TTransformerDeps

Dependencies required by the transformer

TValidatorDeps

TValidatorDeps

Dependencies required by the validator

Properties

loader

readonly loader: Stream<Type<TLoadSchema>, LoadingError, TLoaderDeps>

Defined in: packages/core/src/cms.ts:132

---

loadingSchema

readonly loadingSchema: TLoadSchema

Defined in: packages/core/src/cms.ts:130

---

relations

readonly relations: TRelations

Defined in: packages/core/src/cms.ts:147

---

transformedSchema

readonly transformedSchema: TTransformSchema

Defined in: packages/core/src/cms.ts:131

---

transformer()

readonly transformer: (data) => Effect<Type<TTransformSchema>, TransformationError, TTransformerDeps>

Defined in: packages/core/src/cms.ts:137

Parameters

data

Type<TLoadSchema>

Returns

Effect<Type<TTransformSchema>, TransformationError, TTransformerDeps>

---

validator()

readonly validator: (data) => Effect<void, ValidationError, TValidatorDeps>

Defined in: packages/core/src/cms.ts:144

Parameters

data

Type<TTransformSchema>

Returns

Effect<void, ValidationError, TValidatorDeps>