K6Resource.withScript

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /CommunityToolkit.Aspire.Hosting.k6
5. /K6Resource
6. /withScript

Method

📦 CommunityToolkit.Aspire.Hosting.k6 v13.5.0

interface K6Resource {
  // ... omitted for brevity
  withScript(
      scriptPath: string,
      virtualUsers?: number,
      duration?: string): K6Resource;
}

Signature

methodwithScriptbuilder

Runs a k6 JS script when starting the Grafana k6 container resource.

withScript(
    scriptPath: string,
    virtualUsers?: number,
    duration?: string): K6Resource

Parameters

scriptPathstring

virtualUsersnumberoptional= 10

durationstringoptional= 30s

Returns

K6Resource

Defined on

This method is defined on the following type:

handleK6Resource3 members