Caido
GuidesTutorialsReferenceConcepts

@caido/sdk-workflow ​

This is the reference for the workflow SDK used by JS Nodes. SDK is the main interface that provides access to various services and functionalities.

SDK ​

SDK ​

SDK = object

The SDK object available to all scripts.

Properties ​

console ​

console: Console

The console for logging.

This is currently the same as the global console.

env ​

env: EnvironmentSDK

The SDK for the Environment service.

findings ​

findings: FindingsSDK

The SDK for the Findings service.

graphql ​

graphql: GraphQLSDK

The SDK for the GraphQL service.

hostedFile ​

hostedFile: HostedFileSDK

The SDK for the HostedFile service.

net ​

net: NetSDK

The SDK for the Net service.

projects ​

projects: ProjectsSDK

The SDK for the Projects service.

replay ​

replay: ReplaySDK

The SDK for the Replay service.

requests ​

requests: RequestsSDK

The SDK for the Requests service.

runtime ​

runtime: RuntimeSDK

The SDK for the runtime information.

scope ​

scope: ScopeSDK

The SDK for the Scope service.

Methods ​

asString() ​

asString(array: Bytes): string

Converts bytes to a string.

Unprintable characters will be replaced with �.

Parameters ​
ParameterType
arrayBytes
Returns ​

string

Example ​
js
export function run(input, sdk) {
  let parsed = sdk.asString(input);
  sdk.console.log(parsed);
  return parsed;
}

API Reference ​