lifecycle namespace

Functions

Function Description
afterFirstDeploy(action) Registers an action to be executed automatically post-deployment when resources in this codebase are deployed for the first time.
afterRedeploy(action) Registers an action to be executed automatically post-deployment when resources in this codebase are updated.

Interfaces

Interface Description
CallAction
TaskAction

Type Aliases

Type Alias Description
HttpAction
LifecycleAction

lifecycle.afterFirstDeploy()

Registers an action to be executed automatically post-deployment when resources in this codebase are deployed for the first time.

Signature:

export declare function afterFirstDeploy(action: LifecycleAction): void;

Parameters

Parameter Type Description
action LifecycleAction The lifecycle action to execute.

Returns:

void

lifecycle.afterRedeploy()

Registers an action to be executed automatically post-deployment when resources in this codebase are updated.

Signature:

export declare function afterRedeploy(action: LifecycleAction): void;

Parameters

Parameter Type Description
action LifecycleAction The lifecycle action to execute.

Returns:

void

lifecycle.HttpAction

Signature:

export type HttpAction = ({
    function: string;
} | {
    url: string;
}) & {
    method?: "GET" | "POST" | "PUT" | "DELETE";
    headers?: Record<string, string>;
    body?: unknown;
};

lifecycle.LifecycleAction

Signature:

export type LifecycleAction = {
    task: TaskAction;
    call?: never;
    http?: never;
} | {
    call: CallAction;
    task?: never;
    http?: never;
} | {
    http: HttpAction;
    task?: never;
    call?: never;
};