betwin

    

🤞 Get values in between 2 single digits or single alphabets

Installation

``bash
npm i betwin
`

🎵 Usage

if first value is bigger than last value, return elements in descending order.

both type and run time are tested

deeply typed

The return type is not perfect, I will improve it again when I have more time.

`ts
import betwin from 'betwin'

// digit
betwin(0, 9) // [1, 2, 3, 4, 5, 6, 7, 8], type: Exclude[]
betwin(6, 3) // [5, 4], type: Exclude[]

// string digit
betwin('0', '9') // ['1', '2', '3', '4', '5', '6', '7', '8'], type: Exclude[]
betwin('6', '3') // ['5', '4'], type: Exclude[]

// lower case
betwin('p', 'v') // ['q', 'r', 's', 't', 'u'], type: Exclude[]
betwin('e', 'a') // ['d', 'c', 'b'], type: Exclude[]

// upper case
betwin('P', 'V') // ['Q', 'R', 'S', 'T', 'U'], type: Exclude[]
betwin('E', 'A') // ['D', 'C', 'B'], type: Exclude[]

// accept supertype
betwin(8 as number, 4) // [7, 6, 5, 4], type: Exclude[]
betwin('T', 'U' as string) // ['v'], type: Exclude[]
betwin('t' as string, 'u' as string) // ['v'], type: Exclude[]

// same arguments trigger type error
betwin(5, 5) // [], type: Exclude[]

// out of bound data trigger type error and return undefined
betwin(11, 22) // undefined, type: number[] | undefined
betwin('11', '22') // undefined, type: string[] | undefined
betwin('PP', 'VV') // undefined, type: string[] | undefined
betwin(-4.1, 7.2) // undefined, type : number[] | undefined

// different data types trigger type error and return undefined
betwin('1', 1) // undefined, type: undefined
betwin('b', 'E') // undefined, type: undefined
betwin('abc' as string, -7) // undefined, type: undefined
betwin(99.9 as number, 'xy' as string) // undefined, type: undefined
betwin(0.45, 'U' as string) // undefined, type: undefined
`

see test for more examples

🔨 Utility

in case you need some predefined types:

`ts
import { UpperCaseChar, LowerCaseChar, Digit, StringDigit } from 'betwin'
`

where

`ts
type StringDigit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

type Digit = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

type LowerCaseChar =
| 'a'
| 'b'
| 'c'
| 'd'
| 'e'
| 'f'
| 'g'
| 'h'
| 'i'
| 'j'
| 'k'
| 'l'
| 'm'
| 'n'
| 'o'
| 'p'
| 'q'
| 'r'
| 's'
| 't'
| 'u'
| 'v'
| 'w'
| 'x'
| 'y'
| 'z'

type UpperCaseChar =
| 'A'
| 'B'
| 'C'
| 'D'
| 'E'
| 'F'
| 'G'
| 'H'
| 'I'
| 'J'
| 'K'
| 'L'
| 'M'
| 'N'
| 'O'
| 'P'
| 'Q'
| 'R'
| 'S'
| 'T'
| 'U'
| 'V'
| 'W'
| 'X'
| 'Y'
| 'Z'
``