bb26 3.0.0 → 3.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bb26",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Utilities for working with bijective base-26 numerals",
   "keywords": [
     "base 26",

package/readme.md

@@ -1,6 +1,5 @@
 # BB26
 
-[![Badge indicating minified and gzipped size of BB26](https://badgen.net/bundlephobia/minzip/bb26)](https://bundlephobia.com/result?p=bb26)
 [![Badge indicating number of weekly downloads of BB26 from npm package registry](https://badgen.net/npm/dw/bb26)](https://www.npmjs.com/package/bb26)
 [![Badge indicating percent test coverage of BB26](https://badgen.net/codeclimate/coverage/patrik-csak/BB26?label=test+coverage)](https://codeclimate.com/github/patrik-csak/BB26/test_coverage)
 
@@ -19,6 +18,9 @@ Decimal: | 1 | 2 | 3 | ... | 24 | 25 | 26 | 27 | 28 | 29 | ...
 
 ## Install
 
+> **Note**
+> This package is a native ECMAScript Module (ESM). If your project is not ESM, read [Sindre Sorhus’s Pure ESM package article](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c)
+
 ```sh
 npm install bb26
 ```
@@ -27,87 +29,87 @@ npm install bb26
 
 ### `increment()`
 
-```
-increment(string: string): string
+```ts
+function increment(string: string): string;
 ```
 
 Increments a bijective base-26 string by one numeral.
 
 ```js
-import { increment } from 'bb26'
+import { increment } from "bb26";
 
-increment('A')  // 'B'
-increment('Z')  // 'AA'
-increment('AA') // 'AB'
+increment("A");  // 'B'
+increment("Z");  // 'AA'
+increment("AA"); // 'AB'
 ```
 
 ### `random()`
 
-```
-random(upper: string): string
-random(lower: string, upper: string): string
+```ts
+function random(upper: string): string
+function random(lower: string, upper: string): string
 ```
 
 Produces a random string between the inclusive `lower` and `upper` bounds. If only one argument is provided, a string between `'A'` and the given string is returned.
 
 ```js
-import { random } from 'bb26'
+import { random } from "bb26";
 
-random('AAA')         // 'NE'
-random('AAA', 'AAAA') // 'KXZ'
+random("AAA");         // 'NE'
+random("AAA", "AAAA"); // 'KXZ'
 ```
 
 ### `range()`
 
-```
-range(end: string): string[]
-range(start: string, end: string): string[]
+```ts
+function range(end: string): string[]
+function range(start: string, end: string): string[]
 ```
 
 Creates an array of bijective base-26 numerals progressing from `start` up to, but not including, `end`. If `end` is not specified, it's set to `start` with `start` then set to `'A'`.
 
 ```js
-import { range } from 'bb26'
+import { range } from "bb26";
 
-range('B')       // ['A']
-range('C')       // ['A', 'B']
-range('B', 'C')  // ['B']
-range('B', 'D')  // ['B', 'C']
-range('Z', 'AC') // ['Z', 'AA', 'AB']
+range("B");       // ['A']
+range("C");       // ['A', 'B']
+range("B", "C");  // ['B']
+range("B", "D");  // ['B', 'C']
+range("Z", "AC"); // ['Z', 'AA', 'AB']
 ```
 
 ### `toBb26()`
 
-```
-toBb26(number: number): string
+```ts
+function toBb26(number: number): string;
 ```
 
 Converts a decimal number to a bijective base-26 string.
 
 ```js
-import { toBb26 } from 'bb26'
+import { toBb26 } from "bb26";
 
-toBb26(1)  // 'A'
-toBb26(2)  // 'B'
-toBb26(26) // 'Z'
-toBb26(27) // 'AA'
-toBb26(28) // 'AB'
+toBb26(1);  // 'A'
+toBb26(2);  // 'B'
+toBb26(26); // 'Z'
+toBb26(27); // 'AA'
+toBb26(28); // 'AB'
 ```
 
 ### `toDecimal()`
 
-```
-toDecimal(string: string): number
+```ts
+function toDecimal(string: string): number;
 ```
 
 Converts a bijective base-26 string to a decimal number.
 
 ```js
-import { toDecimal } from 'bb26'
+import { toDecimal } from "bb26";
 
-toDecimal('A')  // 1
-toDecimal('B')  // 2
-toDecimal('Z')  // 26
-toDecimal('AA') // 27
-toDecimal('AB') // 28
+toDecimal("A");  // 1
+toDecimal("B");  // 2
+toDecimal("Z");  // 26
+toDecimal("AA"); // 27
+toDecimal("AB"); // 28
 ```