Skip to content

Commit 33f6cc7

Browse files
committed
docs: add feat customAttributes description
1 parent 3c9c813 commit 33f6cc7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

readme.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,12 @@ Description:
9797

9898
> **Note:** While emoji visually looks like a great way to reduce the size of input values, they often use 3-4 bytes or more (some can be over 20 bytes for a single rendered glyph). The below example 3 emoji string values range between 10-12 bytes in size, that's equivalent to ASCII strings up to 12 characters long. Meanwhile base36(`0-9,a-z`) provides an "alphabet" of 36 characters and an equivalent length of 3 characters is more than enough for most users (`36^3 = 46656`).
9999
100+
### `customAttributes`
101+
102+
Type: `Array`
103+
Default: `[]`
104+
Description: *Custom attribute names that will be involved in the process*
105+
100106
## TODO
101107

102108
- Option to define own generator function.

0 commit comments

Comments
 (0)