Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/windmill/mod.ts>ScriptService

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

Static Methods

archiveScriptByHash(unnamed 0: { workspace: string; hash: string; }): CancelablePromise<Script>

archive script by hash

archiveScriptByPath(unnamed 0: { workspace: string; path: string; }): CancelablePromise<string>

archive script by path

createScript(unnamed 0: { workspace: string; requestBody: NewScript; }): CancelablePromise<string>

create script

deleteScriptByHash(unnamed 0: { workspace: string; hash: string; }): CancelablePromise<Script>

delete script by hash (erase content but keep hash, require admin)

deleteScriptByPath(unnamed 0: { workspace: string; path: string; }): CancelablePromise<string>

delete all scripts at a given path (require admin)

existsScriptByPath(unnamed 0: { workspace: string; path: string; }): CancelablePromise<boolean>

exists script by path

getHubScriptByPath(unnamed 0: { path: string; }): CancelablePromise<{ content: string; lockfile?: string; schema?: any; language: string; summary?: string; }>

get full hub script by path

getHubScriptContentByPath(unnamed 0: { path: string; }): CancelablePromise<string>

get hub script content by path

getScriptByHash(unnamed 0: { workspace: string; hash: string; }): CancelablePromise<Script>

get script by hash

getScriptByPath(unnamed 0: { workspace: string; path: string; }): CancelablePromise<Script>

get script by path

getScriptByPathWithDraft(unnamed 0: { workspace: string; path: string; }): CancelablePromise<NewScriptWithDraft>

get script by path with draft

getScriptDeploymentStatus(unnamed 0: { workspace: string; hash: string; }): CancelablePromise<{ lock?: string; lock_error_logs?: string; }>

get script deployment status

getScriptHistoryByPath(unnamed 0: { workspace: string; path: string; }): CancelablePromise<Array<ScriptHistory>>

get history of a script by path

getTopHubScripts(unnamed 0: { limit?: number; app?: string; kind?: string; }): CancelablePromise<{ asks?: Array<{ id: number; ask_id: number; summary: string; app: string; version_id: number; kind: HubScriptKind; votes: number; views: number; }>; }>

get top hub scripts

listScriptPaths(unnamed 0: { workspace: string; }): CancelablePromise<Array<string>>

list all scripts paths

listScripts(unnamed 0: { workspace: string; page?: number; perPage?: number; orderDesc?: boolean; createdBy?: string; pathStart?: string; pathExact?: string; firstParentHash?: string; lastParentHash?: string; parentHash?: string; showArchived?: boolean; isTemplate?: boolean; kinds?: string; starredOnly?: boolean; }): CancelablePromise<Array<Script>>

list all scripts

listSearchScript(unnamed 0: { workspace: string; }): CancelablePromise<Array<{ path: string; content: string; }>>

list scripts for search

queryHubScripts(unnamed 0: { text: string; kind?: string; limit?: number; app?: string; }): CancelablePromise<Array<{ ask_id: number; id: number; version_id: number; summary: string; app: string; kind: HubScriptKind; score: number; }>>

query hub scripts by similarity

rawScriptByHash(unnamed 0: { workspace: string; path: string; }): CancelablePromise<string>

raw script by hash

rawScriptByPath(unnamed 0: { workspace: string; path: string; }): CancelablePromise<string>

raw script by path

rawScriptByPathTokened(unnamed 0: { workspace: string; token: string; path: string; }): CancelablePromise<string>

raw script by path with a token (mostly used by lsp to be used with import maps to resolve scripts)

toggleWorkspaceErrorHandlerForScript(unnamed 0: { workspace: string; path: string; requestBody: { muted?: boolean; }; }): CancelablePromise<string>

Toggle ON and OFF the workspace error handler for a given script

updateScriptHistory(unnamed 0: { workspace: string; hash: string; path: string; requestBody: { deployment_msg?: string; }; }): CancelablePromise<string>

update history of a script