close
Rslint

    prefer-global/buffer

    Unreleased

    Configuration

    rslint.config.ts
    import { defineConfig, nodePlugin } from '@rslint/core';

export default defineConfig([
  nodePlugin.configs.recommended,
  {
    rules: {
      'node/prefer-global/buffer': 'error',
    },
  },
]);

    Enforces consistent use of the global Buffer or the Buffer export from the Node.js buffer module.

    Options

    import { globals } from '@rslint/core';

export default [{
  plugins: ['node'],
  languageOptions: { globals: globals.node },
  rules: {
    'node/prefer-global/buffer': ['error', 'always'],
  },
}];
    • "always" (default) requires the global Buffer.
    • "never" requires the module export instead of the global Buffer.

    The rule recognizes buffer and node:buffer, including CommonJS, ES module imports and process.getBuiltinModule(). It follows aliases and destructuring and respects local bindings that shadow globals. It does not provide automatic fixes or suggestions.

    Examples

    With "always", these uses are incorrect:

    const { Buffer } = require('node:buffer');
import { Buffer as NodeBuffer } from 'buffer';

    Use the global instead:

    const bytes = Buffer.alloc(16);

    With "never", the global use above is incorrect. Import Buffer instead:

    import { Buffer } from 'node:buffer';
const bytes = Buffer.alloc(16);

    References