bare-stream 2.13.3: isEnded

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify bare-stream.isEnded in pkg:npm/bare-stream@2.13.3
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/bare-stream@2.13.3
Demonstrate these symbols/APIs:
  - bare-stream.isEnded

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:479f79b49ecd3f203d41e898cd453c6be8f51e2c7248338bfac53fd48156e1d8","contract":["isEnded returns false for a newly created Readable stream before consumption","isEnded returns true for a Readable stream after all chunks have been consumed to end","isEnded returns false for a Writable stream that has finished writing","isEnded returns false for a Transform stream initially and true after all data is consumed","isEnded returns false for a PassThrough stream initially and true after all data is consumed","isEnded returns false for a Readable stream destroyed before completing consumption","isEnded returns false for plain objects without stream readable state","isEnded throws TypeError when passed null or undefined"],"goal":"verify bare-stream.isEnded in pkg:npm/bare-stream@2.13.3","kind":"HOW","packages":["pkg:npm/bare-stream@2.13.3"],"schemaVersion":1,"symbols":["bare-stream.isEnded"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/bare-stream@2.13.3"],"schemaVersion":1,"subject":"pkg:npm/bare-stream@2.13.3","symbols":["bare-stream.isEnded"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-bare-stream-is-ended",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-bare-stream-is-ended",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "bare-stream": "2.13.3"
      }
    },
    "node_modules/b4a": {
      "version": "1.8.1",
      "resolved": "https://registry.npmjs.org/b4a/-/b4a-1.8.1.tgz",
      "integrity": "sha512-aiqre1Nr0B/6DgE2N5vwTc+2/oQZ4Wh1t4NznYY4E00y8LCt6NqdRv81so00oo27D8MVKTpUa/MwUUtBLXCoDw==",
      "license": "Apache-2.0",
      "peerDependencies": {
        "react-native-b4a": "*"
      },
      "peerDependenciesMeta": {
        "react-native-b4a": {
          "optional": true
        }
      }
    },
    "node_modules/bare-events": {
      "version": "2.9.2",
      "resolved": "https://registry.npmjs.org/bare-events/-/bare-events-2.9.2.tgz",
      "integrity": "sha512-AIPKioV7/Y/8KfZ3AAhjPJxLLbY49S64Ym5DakZlUg75qQiTgUq9hEJoEwa4eUezPUlXRy/i5NpsKvo9jgKmoA==",
      "license": "Apache-2.0",
      "peerDependencies": {
        "bare-abort-controller": "*"
      },
      "peerDependenciesMeta": {
        "bare-abort-controller": {
          "optional": true
        }
      }
    },
    "node_modules/bare-stream": {
      "version": "2.13.3",
      "resolved": "https://registry.npmjs.org/bare-stream/-/bare-stream-2.13.3.tgz",
      "integrity": "sha512-Kc+brLqvEqGkjyfiwJmImAOqLZL7OsoLKuavx+hJjgVV3nLTOjloJyPMFxjUPerGGHrNH0fLU06jjykMLWrERQ==",
      "license": "Apache-2.0",
      "dependencies": {
        "b4a": "^1.8.1",
        "streamx": "^2.25.0",
        "teex": "^1.0.1"
      },
      "peerDependencies": {
        "bare-abort-controller": "*",
        "bare-buffer": "*",
        "bare-events": "*"
      },
      "peerDependenciesMeta": {
        "bare-abort-controller": {
          "optional": true
        },
        "bare-buffer": {
          "optional": true
        },
        "bare-events": {
          "optional": true
        }
      }
    },
    "node_modules/events-universal": {
      "version": "1.0.1",
      "resolved": "https://registry.npmjs.org/events-universal/-/events-universal-1.0.1.tgz",
      "integrity": "sha512-LUd5euvbMLpwOF8m6ivPCbhQeSiYVNb8Vs0fQ8QjXo0JTkEHpz8pxdQf0gStltaPpw0Cca8b39KxvK9cfKRiAw==",
      "license": "Apache-2.0",
      "dependencies": {
        "bare-events": "^2.7.0"
      }
    },
    "node_modules/fast-fifo": {
      "version": "1.3.2",
      "resolved": "https://registry.npmjs.org/fast-fifo/-/fast-fifo-1.3.2.tgz",
      "integrity": "sha512-/d9sfos4yxzpwkDkuN7k2SqFKtYNmCTzgfEpz82x34IM9/zc8KGxQoXg1liNC/izpRM/MBdt44Nmx41ZWqk+FQ==",
      "license": "MIT"
    },
    "node_modules/streamx": {
      "version": "2.28.1",
      "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.28.1.tgz",
      "integrity": "sha512-zEzXb0s5Cds7tqMH6rhZ05lcJydCWiQPEwiNngVqzsxCc962vLY4Uw+mW7od8kDH258k2Uz/JrOkdIAAhSh9VA==",
      "license": "MIT",
      "dependencies": {
        "events-universal": "^1.0.0",
        "fast-fifo": "^1.3.2",
        "text-decoder": "^1.1.0"
      }
    },
    "node_modules/teex": {
      "version": "1.0.1",
      "resolved": "https://registry.npmjs.org/teex/-/teex-1.0.1.tgz",
      "integrity": "sha512-eYE6iEI62Ni1H8oIa7KlDU6uQBtqr4Eajni3wX7rpfXD8ysFx8z0+dri+KWEPWpBsxXfxu58x/0jvTVT1ekOSg==",
      "license": "MIT",
      "dependencies": {
        "streamx": "^2.12.5"
      }
    },
    "node_modules/text-decoder": {
      "version": "1.2.7",
      "resolved": "https://registry.npmjs.org/text-decoder/-/text-decoder-1.2.7.tgz",
      "integrity": "sha512-vlLytXkeP4xvEq2otHeJfSQIRyWxo/oZGEbXrtEEF9Hnmrdly59sUbzZ/QgyWuLYHctCHxFF4tRQZNQ9k60ExQ==",
      "license": "Apache-2.0",
      "dependencies": {
        "b4a": "^1.6.4"
      }
    }
  }
}

{
  "name": "sample-bare-stream-is-ended",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "license": "MIT-0",
  "dependencies": {
    "bare-stream": "2.13.3"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify bare-stream.isEnded in pkg:npm/bare-stream@2.13.3",
  "kind": "HOW",
  "packages": [
    "pkg:npm/bare-stream@2.13.3"
  ],
  "symbols": [
    "bare-stream.isEnded"
  ]
}

import assert from 'node:assert/strict';
import { isEnded, Readable, Writable, Transform, PassThrough } from 'bare-stream';

// 1. isEnded returns false for a newly created Readable stream before consumption
{
  const stream = Readable.from(['alpha', 'beta', 'gamma']);
  assert.equal(isEnded(stream), false, 'newly created Readable stream must not be ended');
}

// 2. isEnded returns true for a Readable stream after all chunks have been consumed to end
{
  const stream = Readable.from(['chunk1', 'chunk2']);
  for await (const _ of stream) {
    // consume all data from stream
  }
  assert.equal(isEnded(stream), true, 'Readable stream must be ended after consuming all chunks');
}

// 3. isEnded returns false for a Writable stream that has finished writing
{
  const chunks = [];
  const stream = new Writable({
    write(data, encoding, cb) {
      chunks.push(data);
      cb(null);
    }
  });

  assert.equal(isEnded(stream), false, 'Writable stream must not be ended initially');
  stream.write('hello');
  stream.write('world');
  stream.end();

  await new Promise((resolve) => stream.once('close', resolve));
  assert.equal(isEnded(stream), false, 'Writable stream alone does not have ended readable state');
}

// 4. isEnded returns false for a Transform stream initially and true after all data is consumed
{
  const stream = new Transform({
    transform(data, encoding, cb) {
      cb(null, data.toString().toUpperCase());
    }
  });

  assert.equal(isEnded(stream), false, 'Transform stream must not be ended initially');

  stream.end('payload');
  const results = [];
  for await (const chunk of stream) {
    results.push(chunk.toString());
  }

  assert.equal(isEnded(stream), true, 'Transform stream must be ended after all output is read');
  assert.deepEqual(results, ['PAYLOAD']);
}

// 5. isEnded returns false for a PassThrough stream initially and true after all data is consumed
{
  const stream = new PassThrough();
  assert.equal(isEnded(stream), false, 'PassThrough stream must not be ended initially');

  stream.end('test data');
  for await (const _ of stream) {
    // consume pass-through stream
  }

  assert.equal(isEnded(stream), true, 'PassThrough stream must be ended after all data is consumed');
}

// 6. isEnded returns false for a Readable stream destroyed before completing consumption
{
  const stream = new Readable({
    read() {
      // no-op
    }
  });

  stream.destroy();
  await new Promise((resolve) => stream.once('close', resolve));

  assert.equal(isEnded(stream), false, 'Readable stream destroyed before reading to end must not be ended');
}

// 7. isEnded returns false for plain objects without stream readable state
{
  assert.equal(isEnded({}), false, 'plain object without _readableState must return false');
  assert.equal(isEnded({ _readableState: null }), false, 'object with null _readableState must return false');
  assert.equal(isEnded({ _readableState: { ended: false } }), false, 'object with ended: false must return false');
  assert.equal(isEnded({ _readableState: { ended: true } }), true, 'object with ended: true returns true');
}

// 8. isEnded throws TypeError when passed null or undefined
{
  assert.throws(() => isEnded(null), TypeError, 'null argument must throw TypeError');
  assert.throws(() => isEnded(undefined), TypeError, 'undefined argument must throw TypeError');
}

console.log('Contract tests passed successfully.');