this repo has no description
remove redundant example code
-46
-9
source/increment.ts
-9
source/increment.ts
···
2
2
3
3
/**
4
4
* Increments a bijective base-26 string by one numeral.
5
-
*
6
-
* ```
7
-
* import { increment } from 'bb26'
8
-
*
9
-
* increment('A') // 'B'
10
-
* increment('Z') // 'AA'
11
-
* increment('AA') // 'AB'
12
-
* ```
13
-
*
14
5
* @param string - String to increment
15
6
* @return Incremented string
16
7
*/
-7
source/random.ts
-7
source/random.ts
···
9
9
* only one argument is provided, a string between `'A'` and the given string is
10
10
* returned.
11
11
*
12
-
* ```
13
-
* import { random } from 'bb26'
14
-
*
15
-
* random('AAA') // 'NE'
16
-
* random('AAA', 'AAAA') // 'KXZ'
17
-
* ```
18
-
*
19
12
* @param lower
20
13
* @param upper
21
14
* @returns Random string
-10
source/range.ts
-10
source/range.ts
···
9
9
*
10
10
* If `end` is not specified, it's set to `start` with `start` then set to `'A'`.
11
11
*
12
-
* ```
13
-
* import { range } from 'bb26'
14
-
*
15
-
* range('B') // ['A']
16
-
* range('C') // ['A', 'B']
17
-
* range('B', 'C') // ['B']
18
-
* range('B', 'D') // ['B', 'C']
19
-
* range('Z', 'AC') // ['Z', 'AA', 'AB']
20
-
* ```
21
-
*
22
12
* @param start - The start of the range
23
13
* @param end - The end of the range
24
14
*/
-10
source/to-bb26.ts
-10
source/to-bb26.ts
···
5
5
/**
6
6
* Converts a decimal number to a bijective base-26 string.
7
7
*
8
-
* ```
9
-
* import { toBb26 } from 'bb26'
10
-
*
11
-
* toBb26(1) // 'A'
12
-
* toBb26(2) // 'B'
13
-
* toBb26(26) // 'Z'
14
-
* toBb26(27) // 'AA'
15
-
* toBb26(28) // 'AB'
16
-
* ```
17
-
*
18
8
* @param number
19
9
*/
20
10
export default function toBb26(number: number): string {
-10
source/to-decimal.ts
-10
source/to-decimal.ts
···
5
5
/**
6
6
* Converts a bijective base-26 string to a decimal number.
7
7
*
8
-
* ```
9
-
* import { toDecimal } from 'bb26'
10
-
*
11
-
* toDecimal('A') // 1
12
-
* toDecimal('B') // 2
13
-
* toDecimal('Z') // 26
14
-
* toDecimal('AA') // 27
15
-
* toDecimal('AB') // 28
16
-
* ```
17
-
*
18
8
* @param string
19
9
*/
20
10
export default function toDecimal(string: string): number {