Package Exports

@serenity-js/core
@serenity-js/core/lib
@serenity-js/core/lib/Serenity
@serenity-js/core/lib/Serenity.js
@serenity-js/core/lib/adapter
@serenity-js/core/lib/adapter/index.js
@serenity-js/core/lib/config
@serenity-js/core/lib/config/index.js
@serenity-js/core/lib/errors
@serenity-js/core/lib/errors/index.js
@serenity-js/core/lib/events
@serenity-js/core/lib/events/index.js
@serenity-js/core/lib/index.js
@serenity-js/core/lib/io
@serenity-js/core/lib/io/index.js
@serenity-js/core/lib/io/inspected
@serenity-js/core/lib/io/inspected.js
@serenity-js/core/lib/io/stringified
@serenity-js/core/lib/io/stringified.js
@serenity-js/core/lib/model
@serenity-js/core/lib/model/index.js
@serenity-js/core/lib/screenplay
@serenity-js/core/lib/screenplay/index.js
@serenity-js/core/lib/stage
@serenity-js/core/lib/stage/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@serenity-js/core) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

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.