matchinitx v0.0.4

Usage

Install the package

pnpm add matchinitx

Import the package

import { type MatcherRules, useInitxMatcher } from 'matchinitx'

Basic usage

interface CustomField {
  name: string
}

interface CustomResult {
  rule: CustomField
  others: string[]
}

function resultFn(rule: CustomField, ...others: string[]): CustomResult {
  return { rule, others }
}

const rules: MatcherRules<CustomField> = [
  {
    matching: [
      'foo',
      /^bar/
    ],
    name: 'first'
  },
  {
    matching: [
      'test',
      /^t/
    ],
    name: 'second'
  }
]

const matcher = useInitxMatcher<CustomResult, CustomField>(resultFn)

matcher.match(rules, 'foo')
// [{ rule: { name: 'first' }, others: [] }]

matcher.match(rules, 'barfoo')
// [{ rule: { name: 'first' }, others: [] }]

matcher.match(rules, 'test')
// [{ rule: { name: 'second' }, others: [] }]

matcher.match(rules, 'top', 'extra')
// [{ rule: { name: 'second' }, others: ['extra'] }]

Type matcher

enum CustomType {
  FOO = 'foo',
  BAR = 'bar'
}

interface CustomField {
  title: string
}

interface CustomResult {
  rule: CustomField
  type: CustomType
  others: string[]
}

function resultFn(rule: CustomField, type: CustomType, ...others: string[]): CustomResult {
  return { rule, type, others }
}

const rules: MatcherRules<CustomField> = {
  [CustomType.FOO]: {
    matching: [
      'f',
      'o'
    ],
    title: 'a good matcher'
  },
  [CustomType.BAR]: {
    matching: [
      'b',
      'a'
    ],
    title: 'a good title'
  }
}

const matcher = useInitxMatcher<CustomResult, CustomField>(resultFn)

matcher.match(rules, 'f')
matcher.match(rules, 'o')
// [{ rule: { title: 'a good matcher' }, type: 'foo', others: [] }]

matcher.match(rules, 'b', 'extra')
matcher.match(rules, 'a', 'extra')
// [{ rule: { title: 'a good title' }, type: 'bar', others: ['extra'] }]