Interface: ContentLoader

Source: 1.0.0-rc.14 · ecc10ae38a81 (uncommitted changes)

Defined in: packages/valaxy/node/types/loader.ts:26

Properties

devPollInterval?

ts
optional devPollInterval?: number;

Defined in: packages/valaxy/node/types/loader.ts:37

Polling interval (ms) for dev mode. undefined = no polling


load

ts
load: (ctx) => 
  | ContentItem[]
| Promise<ContentItem[]>;

Defined in: packages/valaxy/node/types/loader.ts:30

Parameters

ctx

ContentLoaderContext

Returns

| ContentItem[] | Promise<ContentItem[]>


name

ts
name: string;

Defined in: packages/valaxy/node/types/loader.ts:27


onLoaded?

ts
optional onLoaded?: (ctx) => void | Promise<void>;

Defined in: packages/valaxy/node/types/loader.ts:32

Publish associated metadata only after content has been validated and written.

Parameters

ctx

ContentLoaderContext

Returns

void | Promise<void>


strict?

ts
optional strict?: boolean;

Defined in: packages/valaxy/node/types/loader.ts:29

Validate the complete output before writing; fail production builds on errors.


transform?

ts
optional transform?: (item) => 
  | ContentItem
| Promise<ContentItem>;

Defined in: packages/valaxy/node/types/loader.ts:41

Per-item transform before writing to cache

Parameters

item

ContentItem

Returns

| ContentItem | Promise<ContentItem>