@@ -59,6 +59,8 @@ npm install sqids
59
59
Simple encode & decode:
60
60
61
61
``` javascript
62
+ import Sqids from ' sqids'
63
+
62
64
const sqids = new Sqids ()
63
65
const id = sqids .encode ([1 , 2 , 3 ]) // "86Rf07"
64
66
const numbers = sqids .decode (id) // [1, 2, 3]
@@ -70,6 +72,8 @@ const numbers = sqids.decode(id) // [1, 2, 3]
70
72
Enforce a * minimum* length for IDs:
71
73
72
74
``` javascript
75
+ import Sqids from ' sqids'
76
+
73
77
const sqids = new Sqids ({
74
78
minLength: 10 ,
75
79
})
@@ -80,6 +84,8 @@ const numbers = sqids.decode(id) // [1, 2, 3]
80
84
Randomize IDs by providing a custom alphabet:
81
85
82
86
``` javascript
87
+ import Sqids from ' sqids'
88
+
83
89
const sqids = new Sqids ({
84
90
alphabet: ' FxnXM1kBN6cuhsAvjW3Co7l2RePyY8DwaU04Tzt9fHQrqSVKdpimLGIJOgb5ZE' ,
85
91
})
@@ -90,6 +96,8 @@ const numbers = sqids.decode(id) // [1, 2, 3]
90
96
Prevent specific words from appearing anywhere in the auto-generated IDs:
91
97
92
98
``` javascript
99
+ import Sqids from ' sqids'
100
+
93
101
const sqids = new Sqids ({
94
102
blocklist: new Set ([' 86Rf07' ]),
95
103
})
0 commit comments