Skip to main content

Operation scripts Pro / Enterprise

Operation scripts allow you to define JavaScript code that runs when an operation is invoked. Among other things, it allows you to create tests and view the results of them.

In contrast to other API clients, Kreya does not provide a way to control the execution flow in operation scripts (e.g. with setNextRequest() or similar methods). You can use scripts to do this in Kreya.

Operation scripts can be defined in the Script tab of an operation. The script will run when the operation is sent. Note that the script editor supports autocompletion, simply press Ctrl+Space to bring it up.

Kreya offers a set of useful APIs. Checkout the operation script API reference as well as the general script API reference. You can also share code or import external NPM modules.

As you can see in the screenshot, a global kreya object is provided. View all available properties and methods in the API reference.

Hooks​

Operation scripts use a hook-based execution model. Code written directly at the top level of the script runs before the operation is sent, while code inside hooks runs on a specific event.

Running code before the operation is sent (pre-request script)​

Any code placed at the top level of the script executes before the operation is sent. This is useful for setting up variables, reading data from files, or logging information:

// This runs before the request is sent
console.log('Preparing request...');
const startTime = Date.now();

Running code after the response arrives (post-response script)​

To run code after the response arrives, register a callback using the appropriate hook for your protocol. The hook receives a context object with details about the response:

kreya.rest.onCallCompleted(ctx => {
  kreya.test('Status is 200', () => expect(ctx.status.code).to.equal(200));
});

Available hooks per protocol​

Each protocol exposes its hooks on a dedicated namespace of the kreya object. For example, REST hooks are available on kreya.rest, gRPC hooks on kreya.grpc, and so on.

For the full callback context types and detailed signatures, see the protocol-specific API references: