index.ts

Filename	Percent	Threshold	Total	Covered	Uncovered
src/lookups/states/index.ts	100.00%	80%	71	71	0

import { states } from 'constants/states.js';

/**
 * Lookups that uses state fixtures to cross-reference states by code, abbreviations and name, or gets state and county metadata.
 */
export default class StateLookup {
  private states = states;

  /**
   * @param fips Fips code
   */
  getStateFixtureByFips(fips: string | number) {
    return this.states.find((s) => s.fips === fips);
  }

  /**
   * @param code Edison state code
   */
  getStateFixtureByCode(code: string | number) {
    return this.states.find((s) => s.code === code);
  }

  /**
   * @param nameOrAbbreviation One of: state name, AP abbreviation or postal abbreviation
   */
  getStateFixtureByNameOrAbbreviation(nameOrAbbreviation: string | number) {
    return this.states.find(
      (s) =>
        s.name === nameOrAbbreviation ||
        s.apAbbr === nameOrAbbreviation ||
        s.postalAbbr === nameOrAbbreviation
    );
  }

  /**
   * @param stateIdentifier An identifier for the state, one of: Edison code, FIPS code, state name, AP abbreviation or postal abbreviation
   */
  getStateFixture(stateIdentifier: string | number) {
    let state = this.getStateFixtureByCode(stateIdentifier);
    if (!state) state = this.getStateFixtureByFips(stateIdentifier);
    if (!state)
      state = this.getStateFixtureByNameOrAbbreviation(stateIdentifier);
    if (!state) return null;
    return state;
  }

  /**
   * @param stateIdentifier An identifier for the state, one of: FIPS code, state name, AP abbreviation or postal abbreviation
   */
  getStateCode(stateIdentifier: string | number) {
    // Checks for pseudo states & fixes state code if so, since its stateIdentifier would not be included in the states constant we use to get state fixture
    if (Number(stateIdentifier) > 51) return Number(stateIdentifier);
    return this.getStateFixture(stateIdentifier)?.code;
  }

  /**
   * @param stateIdentifier An identifier for the state, one of: Edison code, state name, AP abbreviation or postal abbreviation
   */
  getStateFips(stateIdentifier: string | number) {
    return this.getStateFixture(stateIdentifier)?.fips;
  }
}

[]

TypeScript Coverage Report generated by type-coverage and typescript-coverage-report at Thu, 04 Apr 2024 19:50:44 GMT

TypeScript coverage report