Interface PendingEffect

An effect a forged tool is about to have, as effectPolicy sees it.

interface PendingEffect {
    capability: "fetch" | "fs.write" | "fs.delete";
    target: string;
    method?: HttpMethod;
    bytes?: number;
    toolId: string;
    agentId: string;
    callId: string;
    dryRun: boolean;
}

Properties

capability target method? bytes? toolId agentId callId dryRun

Properties

capability

capability: "fetch" | "fs.write" | "fs.delete"

target

target: string

The path as written (the parent's real path and the last component), or the URL.

Optional method

method?: HttpMethod

A state-changing request's method.

Optional bytes

bytes?: number

The bytes a write or a request carries.

toolId

toolId: string

agentId

agentId: string

callId

callId: string

dryRun

dryRun: boolean

A forge test's run: nothing it writes, deletes or sends is real.

Settings

Member Visibility

Theme

On This Page

capabilitytargetmethodbytestoolIdagentIdcallIddryRun