`structium` - API documentation

Functions

function defineConfig(config: Config): Config

Define a configuration for structium.

Parameter	Type	Description
`config`	`Config`	The configuration.

The configuration.

type Config: {
  plugins: Record<string, Plugin>;
};

Name	Type
`plugins`?	`Record`<`string`, `Plugin`>

type Plugin: {
  deserialize: (input: string) => Promise<Any>;
  serialize: (input: Any) => Promise<string>;
};

Name	Type
`deserialize`	(`input`: `string`) => `Promise`<`Any`>
`serialize`	(`input`: `Any`) => `Promise`<`string`>

const default: Clippium<ClippiumDataWithPlugins>;