#globals

• Type: boolean
• Default: false
• CLI: --globals

Provide global Rstest APIs for test files, such as expect, test, describe, etc.

By default, Rstest does not provide global APIs. If you prefer to use the APIs globally like Jest, you can add globals: true in the config or pass the --globals option to CLI.

npx rstest --globals

import { defineConfig } from '@rstest/core';

export default defineConfig({
  globals: true,
});

#Usage

When you enable globals, you can use the global APIs directly without import { ... } from '@rstest/core'.

- import { describe, expect, it } from '@rstest/core';

describe('Index', () => {
  it('should add two numbers correctly', () => {
    expect(1 + 1).toBe(2);
  });
});

#Available global APIs

When globals is enabled, Rstest injects the following globals:

• test
• describe
• it
• expect
• assert
• beforeAll
• afterAll
• beforeEach
• afterEach
• onTestFinished
• onTestFailed
• rs
• rstest

rs and rstest are aliases with the same runtime utilities.

#TypeScript support

To enable TypeScript to properly recognize the global APIs, add the @rstest/core/globals type declaration in your tsconfig.json:

{
  "compilerOptions": {
    "types": ["@rstest/core/globals"]
  }
}

Alternatively, create a src/rstestEnv.d.ts file to reference the type definitions:

/// <reference types="@rstest/core/globals" />