@types/sic-list
TypeScript icon, indicating that this package has built-in type declarations

0.5.2 • Public • Published

Installation

npm install --save @types/sic-list

Summary

This package contains type definitions for sic-list (https://github.com/596050/sic).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sic-list.

index.d.ts

/**
 * Expects a two-digit sic code. Returns the description for that sic. If not found, it returns undefined.
 */
export function getDescription(code: string): string | undefined;

/**
 * Expects the English sic description. Returns the code for that sic. If not found, it returns undefined.
 */
export function getCode(description: string): string | undefined;

/**
 * Returns an array of all sic descriptions.
 */
export function getDescriptions(): string[];

/**
 * Returns an array of all sic codes.
 */
export function getCodes(): string[];

/**
 * Returns a key-value object of all sics using the description as key.
 */
export function getDescriptionList(): { [description: string]: string };

/**
 * Returns a key-value object of all sics using the code as key.
 */
export function getCodeList(): { [code: string]: string };

/**
 * Returns an array of all sic information, in the same format as it gets imported.
 */
export function getData(): Array<{ code: string; description: string }>;

/**
 * Expects an array of code and sic description pairs to add to the list. Doesn't return anything.
 */
export function overwrite(sics: ReadonlyArray<{ code: string; description: string }>): void;

Additional Details

  • Last updated: Tue, 07 Nov 2023 15:11:36 GMT
  • Dependencies: none

Credits

These definitions were written by TP.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/sic-list

Weekly Downloads

772

Version

0.5.2

License

MIT

Unpacked Size

4.89 kB

Total Files

5

Last publish

Collaborators

  • types