Autocorrect Node Linux x64 Musl Binary

Common errors

Warnings

Install

Imports

• AutoCorrect

  import { AutoCorrect } from 'autocorrect-node';

  This binary package is not directly imported. Users import from the main `autocorrect-node` package, which then transparently loads the correct platform-specific binary, such as this one, at runtime. `autocorrect-node` ships with TypeScript types.

• init

  import { init } from 'autocorrect-node';

  Similar to `AutoCorrect`, the `init` function (if exposed) from the main `autocorrect-node` package is what users interact with. This binary package remains an underlying dependency. Check `autocorrect-node`'s documentation for exact exports.

• autocorrect CLI

  yarn autocorrect --stdin 'hello世界'

  The `autocorrect-node` package also provides a CLI. When `autocorrect-node` is installed, it may automatically use this platform-specific binary. Users typically invoke the CLI via `npx` or `yarn` without directly referencing this binary package.

Quickstart

Demonstrates basic usage of `autocorrect-node`'s `autocorrect` function, showcasing how the underlying native binary (this package) is implicitly utilized for text correction. Also includes a conceptual CLI usage.

import { autocorrect } from 'autocorrect-node';

async function runAutocorrect() {
  const text = "你好Hello世界";
  // This implicitly uses the native binary for correction.
  const correctedText = await autocorrect(text);
  console.log(`Original: ${text}`);
  console.log(`Corrected: ${correctedText}`);

  // Example of using the CLI via programmatic execution (for illustration)
  // In a real app, you'd typically run this directly from the shell or rely on build tools.
  try {
    const { exec } = await import('node:child_process');
    exec(`echo "${text}" | yarn autocorrect --stdin`, (error, stdout, stderr) => {
      if (error) {
        console.error(`CLI exec error: ${error.message}`);
        return;
      }
      if (stderr) {
        console.error(`CLI stderr: ${stderr}`);
        return;
      }
      console.log(`CLI Corrected: ${stdout.trim()}`);
    });
  } catch (e) {
    console.warn("Cannot run CLI example without 'node:child_process' or yarn/npm in path.", e);
  }
}

runAutocorrect().catch(console.error);