naics

naics is a library for dealing with North American Industry Classification System codes.

Installation

npm install naics

Usage

const naics = require("naics");

const industry = naics.Industry.from("51121");

console.log(industry.title); // Software Publishers

Classes

Industry

An industry classification as defined in the 2017 NAICS Descriptions document

Kind: global class

• Industry
  • new Industry(code)
  • instance
    • .code : string
    • .title : string
    • .description : string
    • .category : string
    • .descendants() ⇒ Array.<Industry>
    • .children() ⇒ Array.<Industry>
    • .parent() ⇒ Industry | undefined
  • static
    • .from(code) ⇒ Industry | undefined
    • .codes() ⇒ Iterable.<Industry>
    • .sectors() ⇒ Iterable.<Industry>

new Industry(code)

| Param | Type | Description | | --- | --- | --- | | code | string | an NAICS code |

industry.code : string

The 2-6 digit classification code

Kind: instance property of Industry

industry.title : string

The title of the industry

Kind: instance property of Industry

industry.description : string

The description of the industry

Kind: instance property of Industry

industry.category : string

The 2-6 digit classification code

Kind: instance property of Industry

industry.descendants() ⇒ Array.<Industry>

Gets all descendants of the industry.

Kind: instance method of Industry

industry.children() ⇒ Array.<Industry>

Gets the children of the industry but not it's indirect descendants

Kind: instance method of Industry

industry.parent() ⇒ Industry | undefined

Gets the parent classification of the industry, or nothing if the industry is a Sector.

Kind: instance method of Industry

Industry.from(code) ⇒ Industry | undefined

Get an industry from its code

Kind: static method of Industry
Returns: Industry | undefined - an Industry representing the code provided. If the code was not valid, undefined will be returned.

| Param | Type | Description | | --- | --- | --- | | code | string | an industry code as defined in the 2017 NAICS |

Industry.codes() ⇒ Iterable.<Industry>

Get an Iterable of all codes

Kind: static method of Industry
Returns: Iterable.<Industry> - an Iterable of all industries

Industry.sectors() ⇒ Iterable.<Industry>

Get an Iterable of all codes that represent sectors

Kind: static method of Industry
Returns: Iterable.<Industry> - an Iterable of all sectors

Category : enum

NAICS uses a six-digit coding system to identify particular industries and their placement in this hierarchical structure of the classification system. The first two digits of the code designate the sector, the third digit designates the subsector, the fourth digit designates the industry group, the fifth digit designates the NAICS industry, and the sixth digit designates the national industry. A zero as the sixth digit generally indicates that the NAICS industry and the U.S. industry are the sames

Kind: global enum
Read only: true
Properties

| Name | Type | Default | | --- | --- | --- | | Sector | number | 2 | | Subsector | number | 3 | | IndustryGroup | number | 4 | | NAICSIndustry | number | 5 | | NationalIndustry | number | 6 |

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT