Skip to content

Commit

Permalink
api: update api description files
Browse files Browse the repository at this point in the history
  • Loading branch information
sdstolworthy committed Sep 20, 2023
1 parent b6259a8 commit 2c9cd5a
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion packages/sandbox/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,31 @@
```ts

// @public (undocumented)
export type Hook = () => Promise<void>;

// @public
export class HookHandler {
// (undocumented)
protected postDeploymentHooks: Array<Hook>;
// (undocumented)
protected preDeploymentHooks: Array<Hook>;
// (undocumented)
registerPostDeploymentHook: (hook: Hook) => void;
// (undocumented)
registerPreDeploymentHook: (hook: Hook) => void;
// (undocumented)
unregisterPostDeploymentHook: (hook: Hook) => void;
// (undocumented)
unregisterPreDeploymentHook: (hook: Hook) => void;
}

// @public
export type Sandbox = {
start: (options: SandboxOptions) => Promise<void>;
stop: () => Promise<void>;
delete: (options: SandboxDeleteOptions) => Promise<void>;
};
} & HookHandler;

// @public (undocumented)
export type SandboxDeleteOptions = {
Expand Down

0 comments on commit 2c9cd5a

Please sign in to comment.