[ { "path": ".editorconfig", "content": "root = true\r\n\r\n[*]\r\nend_of_line = lf\r\nindent_size = 2\r\nindent_style = space\r\ntrim_trailing_whitespace = true\r\n" }, { "path": ".eslintignore", "content": "packages/rxjs/integration/import/fixtures" }, { "path": ".eslintrc.json", "content": "{\n \"root\": true,\n \"ignorePatterns\": [\"**/*\"],\n \"plugins\": [\"@nx\"],\n \"overrides\": [\n {\n \"files\": [\"*.ts\", \"*.tsx\"],\n \"extends\": [\"plugin:@nx/typescript\"],\n \"rules\": {\n \"@typescript-eslint/no-explicit-any\": \"off\",\n \"@typescript-eslint/no-unsafe-declaration-merging\": \"off\",\n \"@typescript-eslint/consistent-type-imports\": \"warn\",\n \"@typescript-eslint/consistent-type-exports\": \"warn\",\n \"no-prototype-builtins\": \"off\",\n \"@typescript-eslint/no-inferrable-types\": \"warn\",\n \"@typescript-eslint/no-empty-function\": \"off\",\n \"@typescript-eslint/no-empty-interface\": \"off\"\n }\n },\n {\n \"files\": [\"*.js\", \"*.jsx\"],\n \"extends\": [\"plugin:@nx/javascript\"],\n \"rules\": {}\n },\n {\n \"files\": [\"*.ts\", \"*.tsx\", \"*.js\", \"*.jsx\"],\n \"rules\": {\n \"@nx/enforce-module-boundaries\": [\n \"error\",\n {\n \"enforceBuildableLibDependency\": true,\n \"allow\": [],\n \"depConstraints\": [\n {\n \"sourceTag\": \"*\",\n \"onlyDependOnLibsWithTags\": [\"*\"]\n }\n ]\n }\n ],\n \"@typescript-eslint/no-unused-vars\": \"off\"\n }\n }\n ]\n}\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.yml", "content": "name: Bug Report\ndescription: Bug report for RxJS core behavior.\nbody:\n - type: textarea\n id: description\n attributes:\n label: Describe the bug\n description: |\n A clear and concise description of the behavior.\n validations:\n required: true\n - type: textarea\n id: expected-behavior\n attributes:\n label: Expected behavior\n description: A clear and concise description of what you expect to happen.\n validations:\n required: true\n - type: textarea\n id: code\n attributes:\n label: Reproduction code\n description: Code to create a minimal reproduction.\n render: typescript\n - type: input\n id: repro-link\n attributes:\n label: Reproduction URL\n description: Use [Stackblitz](https://stackblitz.com/fork/rxjs) or a git repo to show a minimal reproduction of the issue. Please also paste the example code in the \"Reproduction code\" section above.\n - type: input\n id: version\n attributes:\n label: Version\n validations:\n required: true\n - type: textarea\n id: environment\n attributes:\n label: Environment\n placeholder: Version of runtime environment, build configuration, etc, that can affect behavior of RxJS.\n - type: textarea\n id: addition\n attributes:\n label: Additional context\n placeholder: Add any other context about the problem here.\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: false\ncontact_links:\n - name: Questions, request, issues other than Rx core bugs\n url: https://github.com/ReactiveX/rxjs/discussions\n about: For general discussions, or request please use discussions.\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "\n\n**Description:**\n\n\n\n**BREAKING CHANGE:** \n\n**Related issue (if exists):**\n" }, { "path": ".github/actions/install-dependencies/action.yml", "content": "name: Install Dependencies\ndescription: 'Prepares the repo by installing dependencies'\ninputs:\n node-version:\n description: 'The node version to setup'\n required: true\n registry-url:\n description: 'Define registry-url'\n required: false\n default: 'https://registry.npmjs.org'\n\n# outputs: - no outputs\n\nruns:\n using: 'composite'\n steps:\n - name: Use Node.js ${{ inputs.node-version }}\n uses: actions/setup-node@v4\n with:\n node-version: ${{ inputs.node-version }}\n registry-url: ${{ inputs.registry-url }}\n\n - name: Get yarn cache directory path\n id: yarn-cache-dir-path\n run: echo \"dir=$(yarn cache dir)\" >> $GITHUB_OUTPUT\n shell: bash\n\n - uses: actions/cache@v3\n id: yarn-cache\n with:\n path: ${{ steps.yarn-cache-dir-path.outputs.dir }}\n key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}\n restore-keys: |\n ${{ runner.os }}-yarn-\n\n - name: Install dependencies\n run: yarn install --frozen-lockfile\n shell: bash\n env:\n YARN_CACHE_FOLDER: ${{ steps.yarn-cache-dir-path.outputs.dir }}\n" }, { "path": ".github/lock.yml", "content": "# Configuration for lock-threads - https://github.com/dessant/lock-threads\n\n# Number of days of inactivity before a closed issue or pull request is locked\ndaysUntilLock: 30\n\n# Issues and pull requests with these labels will not be locked. Set to `[]` to disable\nexemptLabels: []\n\n# Label to add before locking, such as `outdated`. Set to `false` to disable\nlockLabel: false\n\n# Comment to post before locking. Set to `false` to disable\nlockComment: false\n\n# Limit to only `issues` or `pulls`\n# only: issues\n\n# Optionally, specify configuration settings just for `issues` or `pulls`\n# issues:\n# exemptLabels:\n# - help-wanted\n# lockLabel: outdated\n\n# pulls:\n# daysUntilLock: 30\n" }, { "path": ".github/workflows/ci_main.yml", "content": "name: CI\n\non:\n pull_request:\n types: ['opened', 'reopened', 'synchronize']\n\npermissions:\n contents: read\n\njobs:\n build:\n runs-on: ubuntu-latest\n strategy:\n matrix:\n node: ['18', '20']\n\n name: Node ${{ matrix.node }} build\n\n steps:\n - uses: actions/checkout@v4\n\n - name: Install Dependencies\n uses: ./.github/actions/install-dependencies\n with:\n node-version: ${{ matrix.node }}\n\n - name: Build, test and lint all projects (except website)\n run: yarn nx run-many -t build lint test --exclude=rxjs.dev\n\n - name: rxjs lint\n run: yarn workspace rxjs lint\n - name: rxjs build\n run: yarn workspace rxjs build\n - name: rxjs test\n run: yarn workspace rxjs test\n - name: rxjs dtslint\n run: yarn workspace rxjs dtslint\n - name: rxjs test:import\n run: yarn workspace rxjs test:import\n - name: rxjs test:esm\n run: yarn workspace rxjs test:esm\n - name: rxjs.dev build\n run: yarn workspace rxjs.dev build --prod\n - name: rxjs.dev test\n run: yarn workspace rxjs.dev test --watch=false --browsers=ChromeHeadless\n" }, { "path": ".github/workflows/ci_ts_latest.yml", "content": "name: CI (ts@latest)\n\non:\n pull_request:\n types: ['opened', 'reopened', 'synchronize']\n\npermissions:\n contents: read\n\njobs:\n build:\n runs-on: ubuntu-latest\n strategy:\n matrix:\n node: ['20']\n\n name: ts@latest\n\n steps:\n - uses: actions/checkout@v4\n\n - name: Install Dependencies\n uses: ./.github/actions/install-dependencies\n with:\n node-version: ${{ matrix.node }}\n\n - name: build\n run: |\n yarn workspace rxjs add typescript@latest @types/node@latest --peer --no-save\n yarn nx compile rxjs\n" }, { "path": ".github/workflows/publish.yml", "content": "name: publish\n\non:\n # Run manually using the GitHub UI\n workflow_dispatch:\n inputs:\n version:\n description: 'Version to publish'\n required: false\n default: ''\n # ...or whenever a GitHub release gets created\n release:\n types: [published]\n\njobs:\n publish:\n name: Publish to npm\n runs-on: ubuntu-latest\n permissions:\n id-token: write # needed for provenance data generation\n steps:\n - name: Checkout\n uses: actions/checkout@v4\n with:\n fetch-depth: 0 # include tags\n\n - name: Install Dependencies\n uses: ./.github/actions/install-dependencies\n with:\n node-version: 20\n\n - name: Prepare packages for publishing\n run: yarn prepare-packages\n\n - name: Apply updated version to packages\n run: |\n # Use the version from the workflow input if it's set, otherwise use the tag name from the release\n VERSION=${{ github.event.inputs.version || github.ref_name }}\n yarn nx release version $VERSION\n\n - name: Publish packages to npm\n run: node ./scripts/publish.js\n env:\n NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}\n NPM_CONFIG_PROVENANCE: true\n" }, { "path": ".github/workflows/rebase.yml", "content": "on: \n issue_comment:\n types: [created]\npermissions:\n contents: read\nname: Automatic Rebase\njobs:\n rebase:\n permissions:\n contents: write # for cirrus-actions/rebase to push code to rebase\n pull-requests: read # for cirrus-actions/rebase to get info about PR\n name: Rebase\n if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/rebase')\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n with:\n fetch-depth: 0\n - name: Automatic Rebase\n uses: cirrus-actions/rebase@1.2\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n # https://github.community/t5/GitHub-Actions/Workflow-is-failing-if-no-job-can-be-ran-due-to-condition/m-p/38186#M3250\n always_job:\n name: Always run job\n runs-on: ubuntu-latest\n steps:\n - name: Always run\n run: echo \"This job is used to prevent the workflow to fail when all other jobs are skipped.\"\n" }, { "path": ".gitignore", "content": "# Editor-specific\n.idea/\n*.iml\n*.sublime-project\n*.sublime-workspace\n.settings\n.vscode\n\n# Installed libs\nnode_modules/\ntypings/\n\n# Generated\ndist/\n.tshy-build\n\n# Import location artifacts\npackages/rxjs/ajax/\npackages/rxjs/fetch/\npackages/rxjs/operators/\npackages/rxjs/testing/\npackages/rxjs/webSocket/\n\n# Copied Package Files\npackages/**/LICENSE.txt\npackages/**/CODE_OF_CONDUCT.md\n\n# Misc\nnpm-debug.log\n.DS_STORE\n*.tgz\n.eslintcache\npackage-lock.json\n\nintegration/import/**/rx.json\nintegration/import/**/operators.json\n\n\n.nx/cache" }, { "path": ".prettierrc.json", "content": "{\n \"trailingComma\": \"es5\",\n \"singleQuote\": true,\n \"printWidth\": 140,\n \"overrides\": [\n {\n \"files\": [\"spec/**/*.ts\", \"spec-dtslint/**/*.ts\"],\n \"options\": {\n \"requirePragma\": true\n }\n },\n {\n \"files\": [\"spec/operators/**/*.ts\", \"spec/subjects/**/*.ts\"],\n \"options\": {\n \"requirePragma\": false\n }\n }\n ]\n}\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to making participation in our project and\nour community a harassment-free experience for everyone, regardless of age, body\nsize, disability, ethnicity, gender identity and expression, level of experience,\neducation, socio-economic status, nationality, personal appearance, race,\nreligion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment\ninclude:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or\n advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic\n address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable\nbehavior and are expected to take appropriate and fair corrective action in\nresponse to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or\nreject comments, commits, code, wiki edits, issues, and other contributions\nthat are not aligned to this Code of Conduct, or to ban temporarily or\npermanently any contributor for other behaviors that they deem inappropriate,\nthreatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces\nwhen an individual is representing the project or its community. Examples of\nrepresenting a project or community include using an official project e-mail\naddress, posting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event. Representation of a project may be\nfurther defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported by contacting Ben Lesh (ben@benlesh.com), Tracy Lee (tracy@thisdot.co) or OJ Kwon (kwon.ohjoong@gmail.com). All\ncomplaints will be reviewed and investigated and will result in a response that\nis deemed necessary and appropriate to the circumstances. The project team is\nobligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good\nfaith may face temporary or permanent repercussions as determined by other\nmembers of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,\navailable at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html\n\n[homepage]: https://www.contributor-covenant.org\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing to RxJS\n\n[Read and abide by the Code of Conduct](CODE_OF_CONDUCT.md)! Even if you don't read it,\nit still applies to you. Ignorance is not an exemption.\n\nContents\n\n- [Contributing to RxJS](#contributing-to-rxjs)\n - [Submitting a Pull Request (PR)](#submitting-a-pull-request-pr)\n - [After your pull request is merged](#after-your-pull-request-is-merged)\n - [Coding Style Guidelines](#coding-style-guidelines)\n - [Documentation](#documentation)\n - [Unit Tests](#unit-tests)\n - [CI Tests](#ci-tests)\n - [Performance Tests](#performance-tests)\n - [Macro](#macro)\n - [Micro](#micro)\n - [Commit Message Guidelines](#commit-message-guidelines)\n - [Commit Message Format](#commit-message-format)\n - [Revert](#revert)\n - [Type](#type)\n - [Scope](#scope)\n - [Subject](#subject)\n - [Body](#body)\n - [Footer](#footer)\n\n---\n\n- Related documents\n - [Creating Operators](apps/rxjs.dev/content/guide/operators.md#creating-custom-operators)\n - [Writing Marble Tests](apps/rxjs.dev/content/guide/testing/marble-testing.md)\n\n---\n\n(This document is a work in progress and is subject to change)\n\n## Submitting a Pull Request (PR)\n\nBefore you submit your Pull Request (PR) consider the following guidelines:\n\n- Search [GitHub](https://github.com/ReactiveX/RxJS/pulls) for an open or closed PR\n that relates to your submission. You don't want to duplicate effort.\n- Make your changes in a new git branch:\n\n ```shell\n git checkout -b my-fix-branch master\n ```\n\n- Create your patch, following [code style guidelines](#coding-style-guidelines), and **including appropriate test cases**.\n- Run the full test suite and ensure that all tests pass.\n- Commit your changes using a descriptive commit message that follows our\n [commit message guidelines](#commit-message-guidelines). Adherence to these conventions\n is necessary because release notes are automatically generated from these messages.\n\n ```shell\n git commit -a\n ```\n\n Note: the optional commit `-a` command line option will automatically \"add\" and \"rm\" edited files.\n\n- Push your branch to GitHub:\n\n ```shell\n git push origin my-fix-branch\n ```\n\n- In GitHub, send a pull request to `RxJS:master`.\n- If we suggest changes then:\n\n - Make the required updates.\n - Re-run the test suites to ensure tests are still passing.\n - Re-run performance tests to make sure your changes didn't hurt performance.\n - Rebase your branch and force push to your GitHub repository (this will update your Pull Request):\n\n ```shell\n git rebase master -i\n git push -f\n ```\n\n - When updating your feature branch with the requested changes, please do not overwrite the commit history, but rather contain the changes in new commits. This is for the sake of a clearer and easier review process.\n\nThat's it! Thank you for your contribution!\n\n### After your pull request is merged\n\nAfter your pull request is merged, you can safely delete your branch and pull the changes\nfrom the main (upstream) repository:\n\n- Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:\n\n ```shell\n git push origin --delete my-fix-branch\n ```\n\n- Check out the master branch:\n\n ```shell\n git checkout master -f\n ```\n\n- Delete the local branch:\n\n ```shell\n git branch -D my-fix-branch\n ```\n\n- Update your master with the latest upstream version:\n\n ```shell\n git pull --ff upstream master\n ```\n\n## Coding Style Guidelines\n\n- Please use proper types and generics throughout your code.\n- 2 space indentation only\n- favor readability over terseness\n\n(TBD): For now, try to follow the style that exists elsewhere in the source, and use your best judgment.\n\n## Documentation\n\n- The documentation is auto-generated directly from the source code.\n- In short: From the source code we generate JSON documents, describing each operator, function ... and render this JSON within an Angular application\n- The folder `apps/rxjs.dev` contains everything you need for building and developing the docs\n- The [Documentation README](apps/rxjs.dev/README.md) will support you\n- After a PR is merged to master the docs will be published to https://rxjs.dev/\n\n## Unit Tests\n\nUnit tests are located under the [spec directory](/spec). Unit tests over synchronous operators and operations\ncan be written in a standard [chai](https://www.chaijs.com/) style. Unit tests written against any\nasynchronous operator should be written in [Marble Test Style outlined in detail here](apps/rxjs.dev/content/guide/testing/marble-testing.md).\n\nEach operator under test must be in its own file to cover the following cases:\n\n- Never\n- Empty\n- Single/Multiple Values\n- Error in the sequence\n- Never ending sequences\n- Early disposal in sequences\n\nIf the operator accepts a function as an argument from the user/developer (for example `filter(fn)` or `zip(a, fn)`),\nthen it must cover the following cases:\n\n- Success with all values in the callback\n- Success with the context, if any allowed in the operator signature\n- If an error is thrown\n\n### CI Tests\n\n- Using [Travis](https://travis-ci.org/) on your forked version of RxJS will allow running CI tests on that fork before submitting a PR to master\n- Simply create a `Travis` account and add your fork as a new project\n- [Sauce Labs](https://saucelabs.com/) setup will allow performing automated browser tests on the fork. Since `saucelabs` doesn't perform browser tests on a PR, this will help verify test results before PR's are checked into master.\n- In your `Travis` repo configuration, set the environment variables SAUCE_USERNAME and SAUCE_ACCESS_KEY to your `saucelabs` account ([reference](https://cloud.githubusercontent.com/assets/1210596/12679038/b9ba4eb6-c656-11e5-8c9b-b063c9a3f9dc.png))\n- As master runs both of these tests per each check in, it'd be welcome to setup those test before creating your PR\n\n## Performance Tests\n\nOne of the primary goals of this library is (and will continue to be) great performance. As such, we've employed a variety of performance\ntesting techniques.\n\n- DON'T labor over minute variations in ops/sec or milliseconds, there will always be variance in perf test results.\n- DON'T alter a performance test unless absolutely necessary. Performance tests may be compared to previous results from previous builds.\n- DO run tests multiple times and make sure the margins of error are low\n- DO run tests in your feature branches and compare them to master\n- DO add performance tests for all new operators\n- DO add performance tests that you feel are missing from other operators\n- DO add additional performance tests for all worthy code paths. If you develop an operator with special handling for scalar observables,\n please add tests for those scenarios\n\n### Macro\n\n[Macro performance tests](perf/macro) are best written for scenarios where many object instance allocations (or deallocations) are occurring. Operators\nthat create a lot of child subscriptions or operators that emit new objects like Observables and Subjects are definitely worth creating\nmacro performance tests for.\n\nOther scenarios for macro performance testing may include common end-to-end scenarios from real-world apps. If you have a situation in your\napp where you feel RxJS is performing poorly, please [submit an issue](https://github.com/ReactiveX/rxjs/issues/) and include a minimal code example showing\nyour performance issues. We would love to solve perf for your real-world problems and add those tests to our perf test battery.\n\nMacro performance tests can be run by hosting the root directory with any web server (we use [http-server](https://www.npmjs.com/package/http-server)),\nthen running:\n\n```sh\nyarn build_all\nprotractor protractor.conf.js\n```\n\n### Micro\n\n[Micro performance tests](perf/micro) really only serve to test operations per second. They're quick and easy to develop, and provide a reasonable look into the\nrelative performance of our operators versus prior versions. All operators should have corresponding micro performance tests.\n\nMicro performance test can be run with:\n\n```sh\nyarn build_all\nnode perf/micro\n```\n\nIf you wish to run a single micro performance test, you can do so by providing a single argument with the name of the perf test file(s):\n\n```sh\nnode perf/micro zip\n```\n\n## Commit Message Guidelines\n\nWe have very precise rules over how our git commit messages can be formatted. This leads to **more\nreadable messages** that are easy to follow when looking through the **project history**. But also,\nwe use the git commit messages to **generate the RxJS change log**. Helper script `yarn commit`\nprovides command line based wizard to format commit message easily.\n\n### Commit Message Format\n\nEach commit message consists of a **header**, a **body** and a **footer**. The header has a special\nformat that includes a **type**, a **scope** and a **subject**:\n\n```\n(): \n\n\n\n