Skip to content

default.md

Latest commit

 

History

History
191 lines (112 loc) · 5.35 KB

default.md

File metadata and controls

191 lines (112 loc) · 5.35 KB

crystalize.js / Exports / default

Class: default<Crystal, Shard>

Type parameters

Name Type
Crystal extends PlainObject = PlainObject
Shard extends PlainObject = Crystal

Table of contents

Constructors

Methods

Constructors

constructor

• new default<Crystal, Shard>(_opts)

Type parameters

Name Type
Crystal extends PlainObject = PlainObject
Shard extends PlainObject = Crystal

Parameters

Name Type
_opts Opts<Crystal, Shard> | UserOpts<Crystal, Shard>

Defined in

index.ts:63

Methods

focus

▸ focus(seek): default<Crystal, Shard>

Parameters

Name Type
seek ShardSeekFn<Shard>

Returns

default<Crystal, Shard>

Defined in

index.ts:159

leave

▸ leave(count): default<Crystal, Shard>

Parameters

Name Type
count number | (n: number) => number

Returns

default<Crystal, Shard>

Defined in

index.ts:154

take

▸ take(count?): (Crystal | Shard[])[]

Parameters

Name Type Default value
count number Infinity

Returns

(Crystal | Shard[])[]

Defined in

index.ts:202

with

▸ with(shards): default<Crystal, Shard>

Parameters

Name Type
shards Shard | Shard[]

Returns

default<Crystal, Shard>

Defined in

index.ts:163

without

▸ without(seek): default<Crystal, Shard>

Parameters

Name Type
seek ShardSeekFn<Shard>

Returns

default<Crystal, Shard>

Defined in

index.ts:191

Builder

▸ Static Builder<Crystal, Shard>(opts): (custom: Partial<UserOpts<Crystal, Shard>>) => default<Crystal, Shard>

Type parameters

Name Type
Crystal extends PlainObject = PlainObject
Shard extends PlainObject = Crystal

Parameters

Name Type
opts UserOpts<Crystal, Shard>

Returns

fn

▸ (custom?): default<Crystal, Shard>

Parameters
Name Type
custom Partial<UserOpts<Crystal, Shard>>
Returns

default<Crystal, Shard>

Name Type
toJSON () => void

Defined in

index.ts:97