Identify & retrieve sports team data instantly
Basic usage and examples of the resolveTeam function:
import { resolveTeam } from 'resolve-team'
// Standard usage, resolves the team name directly.
const nbaTeam = resolveTeam(`Bos`) // 'Boston Celtics'
// Fuzzy search example
const nflTeam = resolveTeam('gia') // 'New York Giants'
// Retrieving the full team object
const fullTeam = resolveTeam('celtics', { full: true })
/**
* Resolves with the complete team object:
{
name: 'Boston Celtics',
colors: ['#007A33', '#BA9653', '#000000'],
nicknames: ['celtics', 'boston', 'bos', 'celt'],
abbrev: ['BOS'],
}
*/
// Limit search to a specific sport
const nbaTeam2 = resolveTeam('nyk', { sport: 'nba' }) // 'New York Knicks'Resolve Team is a lightweight, simple API that effortlessly identifies sports teams based on input. Partial or misspelled names or abbreviations are irrelevant. Utilizing Fuse.js, it provides a powerful fuzzy search functionality for resolving sports teams.
To integrate Resolve Team into your project, you can install it via npm:
Via npm
npm install resolve-teamVia yarn
yarn add resolve-teamAfter installation, you can use the library to resolve sports team names by importing the resolveTeam function.
| Parameter | Type | Description |
|---|---|---|
| team | string | The team name or abbreviation to search. |
| options | object | (Optional) Configures the search and returned data |
Customization options available:
| Property | Type | Default | Description |
|---|---|---|---|
| sport | string | 'all' | Specific sport category (e.g., 'nba', 'nfl'). |
| threshold | number | 0.4 | Search sensitivity (0-1). Lower values are stricter. |
| full | boolean | false | If true, returns the complete team object. |
Team Interface - This is provided when you use the full option from the library.
interface Team {
name: string
colors: string[]
nicknames: string[]
abbrev: string[]
}Contributions are welcome and greatly appreciated! Please make a PR or open an issue. I'd love to expand the library to include:
- More Sports and their teams
- Fine-tune the fuzzy-search
- Provide better filtering options
- @fearandesire - Initial Creator
This project is licensed under the MIT License—see the LICENSE file for details.