price-extract
TypeScript icon, indicating that this package has built-in type declarations

0.0.5 • Public • Published

Extract Price from String

Performant way to extract price amount and metadatas (currency, decimal & thousands separator) from any string.

npm

Installation

npm install --save price-extract

API

extractPrice( 
    input: string, 
    details?: boolean = false, 
    debug?: boolean = false 
): TPrice | number | null;

type TAmount = { 
    number: number, 
    decsep?: string, 
    grpsep?: string 
}

type TCurrency = { 
    symbol: string, 
    iso: string, 
    match: string, 
    index: number 
}

type TPrice = TAmount & { currency: TCurrency }

Return Value

  • null: When the price could not be parsed
  • number: The extracted price value
  • object: The extract price informations (when details = true)

Example

import extractPrice from 'price-extract';

console.log(
    
    extractPrice('starting from 1 185,36 € (including taxes)'),
    /* 1185.36 */

    extractPrice('$ 85,4556.34'),
    /* 556.34 */

    extractPrice('There is no price here hahaha $$'),
    /* null */
    
    extractPrice('12,456.24 USD', true), 
    /* { 
        number: 12456.24, 
        decsep: '.', 
        grpsep: ',', 
        currency: { 
            symbol: '$', 
            iso: 'USD', 
            match: 'USD',
            index: 10
        } 
    } */
);

Package Sidebar

Install

npm i price-extract

Weekly Downloads

13

Version

0.0.5

License

MIT

Unpacked Size

11.8 kB

Total Files

6

Last publish

Collaborators

  • gaetanlegac