Definition

Defined in: Plugin.ts:85

Type Parameters

Type Parameter
Config
Input
E

Properties

~@graftland/graft/Plugin

readonly "~@graftland/graft/Plugin": "~@graftland/graft/Plugin";

Defined in: Plugin.ts:86

---

~@graftland/graft/Plugin/Contract

readonly "~@graftland/graft/Plugin/Contract": {
  error: 0 extends 1 & E ? unknown : (value: E) => E;
  input: 0 extends 1 & Input ? unknown : (value: Input) => Input;
};

Defined in: Plugin.ts:87

error

readonly error: 0 extends 1 & E ? unknown : (value: E) => E;

input

readonly input: 0 extends 1 & Input ? unknown : (value: Input) => Input;

---

apply

readonly apply: (config: Config) => Effect<
  | void
| Update<Config, E, unknown>, E, unknown>;

Defined in: Plugin.ts:101

Runs only inside an activation, which provides whatever apply needs.

Parameters

Parameter	Type
config	Config

Returns

Effect< | void | Update<Config, E, unknown>, E, unknown>

---

config

readonly config: Top | undefined;

Defined in: Plugin.ts:93

The public configuration schema, when the plugin declares one.

---

decode

readonly decode: (input: Input) => Effect<Config, SchemaError, unknown>;

Defined in: Plugin.ts:97

Runs only inside an activation, which provides whatever decoding needs.

Parameters

Parameter	Type
input	Input

Returns

Effect<Config, SchemaError, unknown>

---

inject

readonly inject: readonly Dependency[];

Defined in: Plugin.ts:94

---

name

readonly name: string;

Defined in: Plugin.ts:91

---

retry

readonly retry: Schedule<unknown, unknown, never, never> | undefined;

Defined in: Plugin.ts:95