Variable: PermissionDecision

PermissionDecision: object;

Construct portable permission decisions for canUseTool and supported hooks.

Type Declaration

allow()

allow(updatedInput?): PermissionDecision;

Approve the request, optionally replacing its input.

Parameters

updatedInput?

Record<string, unknown> Validated replacement tool arguments.

Returns

PermissionDecision An allow decision.

Example

return PermissionDecision.allow()

ask()

ask(): PermissionDecision;

Delegate to the remaining permission path; this is not approval.

Returns

PermissionDecision An ask decision.

Example

return PermissionDecision.ask()

deny()

deny(message?): PermissionDecision;

Reject a request with an optional explanation.

Parameters

message?

string Reason shown to the runtime/model.

Returns

PermissionDecision A deny decision.

Example

return PermissionDecision.deny("Read-only agent")

Overview

Classes

Functions

Interfaces

Types

Variables

Supporting

Type Declaration

allow()

Parameters

updatedInput?

Returns

Example

ask()

Returns

Example

deny()

Parameters

message?

Returns

Example

​Type Declaration

​allow()

​Parameters

updatedInput?

​Returns

​Example

​ask()

​Returns

​Example

​deny()

​Parameters

message?

​Returns

​Example

Type Declaration

allow()

Parameters

Returns

Example

ask()

Returns

Example

deny()

Parameters

Returns

Example