Skip to content

thomaschaplin/cusip-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

95 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

logo

npm version

cusip-generator

cusip-generator is a Node.js library to generate random CUSIP with a single API.

CUSIP stands for Committee on Uniform Securities Identification Procedures. A CUSIP number identifies most financial instruments, including: stocks of all registered U.S. and Canadian companies, commercial paper, and U.S. government and municipal bonds.

CUSIP format (9 characters):

  • Characters 1–6: Issuer code (base-ten digits)
  • Characters 7–8: Issue number (alphanumeric)
  • Character 9: Check digit (computed via checksum algorithm)

Usage

npm i @thomaschaplin/cusip-generator

Example Usage

ES5

const generateCusip = require("@thomaschaplin/cusip-generator");
console.log(generateCusip.generateCusip()); // 327492T38

or

const { generateCusip } = require("@thomaschaplin/cusip-generator");
console.log(generateCusip()); // 5519069J1

ES6

import { generateCusip } from '@thomaschaplin/cusip-generator'
console.log(generateCusip()) // 112091HZ9

TypeScript

import { generateCusip } from '@thomaschaplin/cusip-generator'
const cusip: string = generateCusip()
console.log(cusip) // e.g., 112091HZ9

Setup

Make sure you have Node.js installed on your machine

Development

Installation

  • Clone this repository
    git clone git@github.com:thomaschaplin/cusip-generator.git
  • Change directory
    cd cusip-generator
  • Install the dependencies
    npm install
  • Transpile the code
    npm run build
    or
    npm run watch

Tests

  • Run the tests
    npm test
  • Run the tests with coverage
    npm run test:coverage
  • Run mutation tests
    npm run test:mutation

License

MIT


Logo graphic by Perlenfuerdiehunde from ClipArtKey.

About

πŸ†” Committee on Uniform Securities Identification Procedures (CUSIP) generator

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors