hashids/src/tests/default-params.test.ts

Generate YouTube-like ids from numbers. Use Hashids when you do not want to expose your database ids to the user.

import Hashids from '../hashids'

const hashids = new Hashids()

describe.each([
  ['gY', [0]],
  ['jR', [1]],
  ['R8ZN0', [928_728]],
  ['o2fXhV', [1, 2, 3]],
  ['jRfMcP', [1, 0, 0]],
  ['jQcMcW', [0, 0, 1]],
  ['gYcxcr', [0, 0, 0]],
  ['gLpmopgO6', [1_000_000_000_000]],
  ['lEW77X7g527', [9_007_199_254_740_991]],
  ['BrtltWt2tyt1tvt7tJt2t1tD', [5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5]],
  ['G6XOnGQgIpcVcXcqZ4B8Q8B9y', [10_000_000_000, 0, 0, 0, 999_999_999_999_999]],
  [
    '5KoLLVL49RLhYkppOplM6piwWNNANny8N',
    [9_007_199_254_740_991, 9_007_199_254_740_991, 9_007_199_254_740_991],
  ],
  [
    'BPg3Qx5f8VrvQkS16wpmwIgj9Q4Jsr93gqx',
    [1_000_000_001, 1_000_000_002, 1_000_000_003, 1_000_000_004, 1_000_000_005],
  ],
  [
    '1wfphpilsMtNumCRFRHXIDSqT2UPcWf1hZi3s7tN',
    [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20],
  ],
  // bigint format:
  ...(typeof BigInt === 'function'
    ? require('./bigint-test-cases').defaultParams
    : []),
] as [string, (bigint | number)[]][])(
  'encode/decode using default params',
  (id, numbers) => {
    it(`should encode [${numbers}] to '${id}' (passing array of numbers)`, () => {
      expect(id).toEqual(hashids.encode(numbers))
    })

    it(`should encode [${numbers}] to '${id}' (passing numbers)`, () => {
      expect(id).toEqual(hashids.encode(...numbers))
    })

    it(`should encode [${numbers}] to '${id}' and decode back correctly`, () => {
      const encodedId = hashids.encode(numbers)
      const decodedNumbers = hashids.decode(encodedId)

      expect(numbers).toEqual(decodedNumbers)
    })
  },
)