modules.md

crystalize.js / Exports

crystalize.js

Table of contents

Classes

• default

Type Aliases

• CrystalizerReducer
• Keep
• PlainObject
• Primitive
• ShardSeekFn
• SingleSort
• UserOpts

Type Aliases

CrystalizerReducer

Ƭ CrystalizerReducer<Crystal, Shard>: (crystal: Readonly<Crystal>, shard: Readonly<Shard>) => Crystal

Type parameters

Name
Crystal
Shard

Type declaration

▸ (crystal, shard): Crystal

Parameters

Name	Type
crystal	Readonly<Crystal>
shard	Readonly<Shard>

Returns

Crystal

Defined in

index.ts:19

---

Keep

Ƭ Keep<Shard>: ["all"] | ["none"] | ["count", number] | ["first", ShardSeekFn<Shard>] | ["since", number] | ["min", Keep<Shard>[]] | ["max", Keep<Shard>[]]

Type parameters

Name
Shard

Defined in

index.ts:10

---

PlainObject

Ƭ PlainObject: Object

Index signature

▪ [key: string]: Primitive | Primitive[] | PlainObject

Defined in

index.ts:4

---

Primitive

Ƭ Primitive: string | number | boolean | null | undefined

Defined in

index.ts:3

---

ShardSeekFn

Ƭ ShardSeekFn<Shard>: (shard: Readonly<Shard>) => boolean

Type parameters

Name
Shard

Type declaration

▸ (shard): boolean

Parameters

Name	Type
shard	Readonly<Shard>

Returns

boolean

Defined in

index.ts:8

---

SingleSort

Ƭ SingleSort<Shard>: ["asc" | "desc", string | ShardSeekFn<Shard>]

Type parameters

Name
Shard

Defined in

index.ts:24

---

UserOpts

Ƭ UserOpts<Crystal, Shard>: Object

Type parameters

Name
Crystal
Shard

Type declaration

Name	Type
initial	Crystal
keep?	Keep<Shard>
map?	(shard: Readonly<Shard>) => Shard
reduce	CrystalizerReducer<Crystal, Shard>
sort?	SingleSort<Shard> | SingleSort<Shard>[]
tsKey?	string

Defined in

index.ts:26