Class EnContactMatcher<Contact>

A fuzzy matcher that uses domain knowledge about contacts and sets up a simpler API.

export

Type parameters

Contact

The type of the contact object.

Hierarchy

EnContactMatcher

Index

Constructors

constructor

Properties

config

Methods

Constructors

constructor

new EnContactMatcher<Contact>(contacts: Contact[], extractContactFields?: (contact: Contact) => ContactFields, config?: MatcherConfig): EnContactMatcher<Contact>

- Defined in matchers/contactmatcher.ts:85
Creates an instance of EnContactMatcher.

memberof

EnContactMatcher

Type parameters
- Contact
Parameters
- contacts: Contact[]
  
  The contacts to match against.
- extractContactFields: (contact: Contact) => ContactFields = ...
  - - (contact: Contact): ContactFields
    - Parameters
      - contact: Contact
      Returns ContactFields
- config: MatcherConfig = ...
Returns EnContactMatcher<Contact>

Properties

Readonly config

config: MatcherConfig = ...

Methods

find

find(query: string): Contact[]

- Defined in matchers/contactmatcher.ts:143
Find a contact.

memberof

EnContactMatcher

Parameters
- query: string
  
  The search query.
Returns Contact[]

The matched contacts.

findByAlias

findByAlias(alias: string): Contact[]

- Defined in matchers/contactmatcher.ts:174
Find a contact by only searching over their aliases.

memberof

EnContactMatcher

Parameters
- alias: string
  
  The alias to search for.
Returns Contact[]

The matched contacts.

findByName

findByName(name: string): Contact[]

- Defined in matchers/contactmatcher.ts:160
Find a contact by only searching over their names.

memberof

EnContactMatcher

Parameters
- name: string
  
  The name to search for.
Returns Contact[]

The matched contacts.

Generated using TypeDoc