@serenity-js/core

Serenity/JS Core

@serenity-js/core provides foundational building blocks of the Serenity/JS ecosystem, enabling clean, expressive, and highly maintainable test automation based on the Screenplay Pattern. This package provides APIs and extension points used across all Serenity/JS modules.

Features

• Core APIs for implementing the Screenplay Pattern in automated tests.
• Actor lifecycle and abilities management for clear, maintainable test orchestration.
• Flexible integration points with test runners and reporting tools.
• TypeScript-first design with strong typing for safer and more predictable test code.

Installation

npm install --save-dev @serenity-js/core

See the Serenity/JS Installation Guide.

Quick Start

import { actorCalled } from '@serenity-js/core'

await actorCalled('Alice')
    .whoCan(
        // Add abilities
    )
    .attemptsTo(
        // Add tasks and interactions
    )

Explore practical examples and in-depth explanations in the Serenity/JS Handbook.

Documentation

• API Reference
• Screenplay Pattern Guide
• Serenity/JS Project Templates
• Tutorial: First Web Scenario
• Tutorial: First API Scenario

Contributing

Contributions of all kinds are welcome! Get started with the Contributing Guide.

Community

• Community Chat
• Discussions Forum
  • Visit the How to... ? section for answers to common questions

If you enjoy using Serenity/JS, make sure to star ️ Serenity/JS on GitHub to help others discover the framework!

License

The Serenity/JS code base is licensed under the Apache-2.0 license, while its documentation and the Serenity/JS Handbook are licensed under the Creative Commons BY-NC-SA 4.0 International.

See the Serenity/JS License.

Support

Support ongoing development through GitHub Sponsors. Sponsors gain access to Serenity/JS Playbooks and priority help in the Discussions Forum.

For corporate sponsorship or commercial support, please contact Jan Molak.