Merge pull request #6 from satotake/fix-api

fix(api): change main func name

Author: satotake

__tests__/jp-numerals.ts

@@ -1,4 +1,4 @@
-import { jpNumerals, Numeral, NumeralZero } from '../src/jp-numerals'
+import { numerals, Numeral, NumeralZero } from '../src/jp-numerals'
 import { JpNumeralUnit } from '../src/type'
 
 describe('Numeral Class', () => {
@@ -54,7 +54,7 @@ describe('class NumeralZero', () => {
 
 describe('jpNumerals', () => {
   it('can handle integer', () => {
-    const n = jpNumerals(12_3456_7890)
+    const n = numerals(12_3456_7890)
     expect(n.toTuples()).toEqual([[12, '億'], [3456, '万'], [7890, '']])
 
     expect(n.toNumerals()).toEqual([
@@ -89,17 +89,17 @@ describe('jpNumerals', () => {
   })
 
   it('can handle float', () => {
-    const n = jpNumerals(12_3456_7890.123)
+    const n = numerals(12_3456_7890.123)
     expect(n.toTuples()).toEqual([[12, '億'], [3456, '万'], [7890.123, '']])
   })
 
   it('throw error if number is negative', () => {
-    expect(() => jpNumerals(-12_3456_7890.123)).toThrow()
+    expect(() => numerals(-12_3456_7890.123)).toThrow()
   })
 
   it('can use base as option', () => {
-    const n_base = jpNumerals(12_3456, JpNumeralUnit.万)
-    const n = jpNumerals(12_3456_0000)
+    const n_base = numerals(12_3456, JpNumeralUnit.万)
+    const n = numerals(12_3456_0000)
 
     expect(n_base.toTuples()).toEqual(n.toTuples())
     expect(n_base.toNumerals()).toEqual(n.toNumerals())

src/jp-numerals.ts

@@ -55,7 +55,7 @@ export class NumeralZero extends Numeral {
   }
 }
 
-export const jpNumerals = (n: number, base: JpNumeralUnit = JpNumeralUnit.零): Numerals => {
+export const numerals = (n: number, base: JpNumeralUnit = JpNumeralUnit.零): Numerals => {
   // TODO(handle negative)
   if (n < 0) {
     throw Error('number must be string')
@@ -81,4 +81,4 @@ export const jpNumerals = (n: number, base: JpNumeralUnit = JpNumeralUnit.零):
   }
 }
 
-export default jpNumerals
+export default numerals