Installation

Package Manager

Install the package using your preferred package manager:

npm

npm install @mcabreradev/filter

yarn

yarn add @mcabreradev/filter

pnpm

pnpm add @mcabreradev/filter

bun

bun add @mcabreradev/filter

Requirements

• Node.js: >= 20
• TypeScript: >= 5.0 (optional, but recommended)

Verify Installation

After installation, verify it works:

import { filter } from '@mcabreradev/filter';

const data = [
  { name: 'Alice', age: 30 },
  { name: 'Bob', age: 25 }
];

const result = filter(data, { age: 30 });
console.log(result); // [{ name: 'Alice', age: 30 }]

TypeScript Configuration

For optimal TypeScript support, ensure your tsconfig.json includes:

{
  "compilerOptions": {
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "moduleResolution": "bundler",
    "target": "ES2022",
    "module": "ES2022"
  }
}

Framework-Specific Setup

React

No additional setup required. Import and use:

import { useFilter } from '@mcabreradev/filter';

Vue

No additional setup required. Import and use:

import { useFilter } from '@mcabreradev/filter';

Svelte

No additional setup required. Import and use:

import { useFilter } from '@mcabreradev/filter';

CDN Usage

For quick prototyping, you can use a CDN:

<script type="module">
  import { filter } from 'https://esm.sh/@mcabreradev/filter';

  const data = [{ name: 'Alice' }, { name: 'Bob' }];
  const result = filter(data, 'Alice');
  console.log(result);
</script>

Next Steps

• Quick Start - Start filtering in minutes
• Operators Guide - Learn all available operators
• Framework Integration - Integrate with your framework

Troubleshooting

Module Resolution Issues

If you encounter module resolution issues, ensure your bundler supports ESM:

Vite:

// vite.config.js
export default {
  resolve: {
    alias: {
      '@mcabreradev/filter': '@mcabreradev/filter/build/index.js'
    }
  }
}

Webpack:

// webpack.config.js
module.exports = {
  resolve: {
    extensions: ['.js', '.ts'],
    mainFields: ['module', 'main']
  }
}

TypeScript Errors

If you see TypeScript errors, ensure you have the latest version:

npm install -D typescript@latest

Peer Dependency Warnings

The library has optional peer dependencies for framework integrations. These warnings are safe to ignore if you're not using those frameworks:

WARN  Optional peer dependency not installed: react

To suppress these warnings, you can install only the framework you're using:

# For React
npm install react

# For Vue
npm install vue

# For Svelte
npm install svelte