Skip to main content
Module

x/windmill/mod.ts>ScriptApi

Windmill deno client (separated from the main repo because most of the code is auto-generated from the openapi and not worth committing)
windmill-labs/windmill-deno-client
Extremely Popular
Go to Latest
class ScriptApi
import { ScriptApi } from "https://deno.land/x/windmill@v1.28.1/mod.ts";

Constructors

new
ScriptApi(
configuration: Configuration,
requestFactory?: ScriptApiRequestFactory,
responseProcessor?: ScriptApiResponseProcessor,
)

Properties

private
api: ObservableScriptApi

Methods

archiveScriptByHash(
workspace: string,
hash: string,
_options?: Configuration,
): Promise<Script>

archive script by hash

archiveScriptByPath(
workspace: string,
path: string,
_options?: Configuration,
): Promise<string>

archive script by path

createScript(
workspace: string,
inlineObject15: InlineObject15,
_options?: Configuration,
): Promise<string>

create script

deleteScriptByHash(
workspace: string,
hash: string,
_options?: Configuration,
): Promise<Script>

delete script by hash (erase content but keep hash)

denoToJsonschema(body: string, _options?: Configuration): Promise<MainArgSignature>

inspect deno code to infer jsonschema of arguments

existsScriptByPath(
workspace: string,
path: string,
_options?: Configuration,
): Promise<boolean>

exists script by path

getHubScriptContentByPath(path: string, _options?: Configuration): Promise<string>

get hub script content by path

getScriptByHash(
workspace: string,
hash: string,
_options?: Configuration,
): Promise<Script>

get script by hash

getScriptByPath(
workspace: string,
path: string,
_options?: Configuration,
): Promise<Script>

get script by path

getScriptDeploymentStatus(
workspace: string,
hash: string,
_options?: Configuration,
): Promise<InlineResponse2005>

get script deployment status

listHubScripts(_options?: Configuration): Promise<InlineResponse2002>

list all available hub scripts

listScripts(
workspace: string,
page?: number,
perPage?: number,
orderDesc?: boolean,
createdBy?: string,
pathStart?: string,
pathExact?: string,
firstParentHash?: string,
lastParentHash?: string,
parentHash?: string,
showArchived?: boolean,
isTemplate?: boolean,
isTrigger?: boolean,
_options?: Configuration,
): Promise<Array<Script>>

list all available scripts

pythonToJsonschema(body: string, _options?: Configuration): Promise<MainArgSignature>

inspect python code to infer jsonschema of arguments