@xylabs/arraybuffer 4.13.20 → 4.13.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +253 -3
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -12,13 +12,263 @@
|
|
|
12
12
|
[![snyk-badge][]][snyk-link]
|
|
13
13
|
[![socket-badge][]][socket-link]
|
|
14
14
|
|
|
15
|
-
Version: 4.13.19
|
|
16
15
|
|
|
17
16
|
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
|
|
18
17
|
|
|
19
|
-
##
|
|
18
|
+
## Reference
|
|
19
|
+
|
|
20
|
+
**@xylabs/arraybuffer**
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
## Functions
|
|
25
|
+
|
|
26
|
+
- [equalArrayBuffers](#functions/equalArrayBuffers)
|
|
27
|
+
- [isArrayBuffer](#functions/isArrayBuffer)
|
|
28
|
+
- [isArrayBufferLike](#functions/isArrayBufferLike)
|
|
29
|
+
- [toArrayBuffer](#functions/toArrayBuffer)
|
|
30
|
+
- [toUint8Array](#functions/toUint8Array)
|
|
31
|
+
|
|
32
|
+
### functions
|
|
33
|
+
|
|
34
|
+
### <a id="equalArrayBuffers"></a>equalArrayBuffers
|
|
35
|
+
|
|
36
|
+
[**@xylabs/arraybuffer**](#../README)
|
|
37
|
+
|
|
38
|
+
***
|
|
39
|
+
|
|
40
|
+
```ts
|
|
41
|
+
function equalArrayBuffers(a1, a2): boolean;
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Parameters
|
|
45
|
+
|
|
46
|
+
### a1
|
|
47
|
+
|
|
48
|
+
`ArrayBufferLike`
|
|
49
|
+
|
|
50
|
+
### a2
|
|
51
|
+
|
|
52
|
+
`ArrayBufferLike`
|
|
53
|
+
|
|
54
|
+
## Returns
|
|
55
|
+
|
|
56
|
+
`boolean`
|
|
57
|
+
|
|
58
|
+
### <a id="isArrayBuffer"></a>isArrayBuffer
|
|
59
|
+
|
|
60
|
+
[**@xylabs/arraybuffer**](#../README)
|
|
61
|
+
|
|
62
|
+
***
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
function isArrayBuffer(value): value is ArrayBuffer;
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Parameters
|
|
69
|
+
|
|
70
|
+
### value
|
|
71
|
+
|
|
72
|
+
`unknown`
|
|
73
|
+
|
|
74
|
+
## Returns
|
|
75
|
+
|
|
76
|
+
`value is ArrayBuffer`
|
|
77
|
+
|
|
78
|
+
### <a id="isArrayBufferLike"></a>isArrayBufferLike
|
|
79
|
+
|
|
80
|
+
[**@xylabs/arraybuffer**](#../README)
|
|
81
|
+
|
|
82
|
+
***
|
|
83
|
+
|
|
84
|
+
```ts
|
|
85
|
+
function isArrayBufferLike(value): value is ArrayBufferLike;
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Parameters
|
|
89
|
+
|
|
90
|
+
### value
|
|
91
|
+
|
|
92
|
+
`unknown`
|
|
93
|
+
|
|
94
|
+
## Returns
|
|
95
|
+
|
|
96
|
+
`value is ArrayBufferLike`
|
|
97
|
+
|
|
98
|
+
### <a id="toArrayBuffer"></a>toArrayBuffer
|
|
99
|
+
|
|
100
|
+
[**@xylabs/arraybuffer**](#../README)
|
|
101
|
+
|
|
102
|
+
***
|
|
103
|
+
|
|
104
|
+
## Call Signature
|
|
105
|
+
|
|
106
|
+
```ts
|
|
107
|
+
function toArrayBuffer(
|
|
108
|
+
value,
|
|
109
|
+
padLength?,
|
|
110
|
+
base?): undefined;
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Parameters
|
|
114
|
+
|
|
115
|
+
### value
|
|
116
|
+
|
|
117
|
+
`undefined`
|
|
118
|
+
|
|
119
|
+
### padLength?
|
|
120
|
+
|
|
121
|
+
`number`
|
|
122
|
+
|
|
123
|
+
### base?
|
|
124
|
+
|
|
125
|
+
`number`
|
|
126
|
+
|
|
127
|
+
### Returns
|
|
128
|
+
|
|
129
|
+
`undefined`
|
|
130
|
+
|
|
131
|
+
## Call Signature
|
|
132
|
+
|
|
133
|
+
```ts
|
|
134
|
+
function toArrayBuffer(
|
|
135
|
+
value,
|
|
136
|
+
padLength?,
|
|
137
|
+
base?): ArrayBufferLike;
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Parameters
|
|
141
|
+
|
|
142
|
+
### value
|
|
143
|
+
|
|
144
|
+
`string` | `bigint` | `ArrayBufferLike`
|
|
145
|
+
|
|
146
|
+
### padLength?
|
|
147
|
+
|
|
148
|
+
`number`
|
|
149
|
+
|
|
150
|
+
### base?
|
|
151
|
+
|
|
152
|
+
`number`
|
|
153
|
+
|
|
154
|
+
### Returns
|
|
155
|
+
|
|
156
|
+
`ArrayBufferLike`
|
|
157
|
+
|
|
158
|
+
## Call Signature
|
|
159
|
+
|
|
160
|
+
```ts
|
|
161
|
+
function toArrayBuffer(
|
|
162
|
+
value,
|
|
163
|
+
padLength?,
|
|
164
|
+
base?): undefined | ArrayBufferLike;
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### Parameters
|
|
168
|
+
|
|
169
|
+
### value
|
|
170
|
+
|
|
171
|
+
`undefined` | `string` | `bigint` | `ArrayBufferLike`
|
|
172
|
+
|
|
173
|
+
### padLength?
|
|
174
|
+
|
|
175
|
+
`number`
|
|
176
|
+
|
|
177
|
+
### base?
|
|
178
|
+
|
|
179
|
+
`number`
|
|
180
|
+
|
|
181
|
+
### Returns
|
|
182
|
+
|
|
183
|
+
`undefined` \| `ArrayBufferLike`
|
|
184
|
+
|
|
185
|
+
### <a id="toUint8Array"></a>toUint8Array
|
|
186
|
+
|
|
187
|
+
[**@xylabs/arraybuffer**](#../README)
|
|
188
|
+
|
|
189
|
+
***
|
|
190
|
+
|
|
191
|
+
## Call Signature
|
|
192
|
+
|
|
193
|
+
```ts
|
|
194
|
+
function toUint8Array(
|
|
195
|
+
value,
|
|
196
|
+
padLength?,
|
|
197
|
+
base?): undefined;
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
### Parameters
|
|
201
|
+
|
|
202
|
+
### value
|
|
203
|
+
|
|
204
|
+
`undefined`
|
|
205
|
+
|
|
206
|
+
### padLength?
|
|
207
|
+
|
|
208
|
+
`number`
|
|
209
|
+
|
|
210
|
+
### base?
|
|
211
|
+
|
|
212
|
+
`number`
|
|
213
|
+
|
|
214
|
+
### Returns
|
|
215
|
+
|
|
216
|
+
`undefined`
|
|
217
|
+
|
|
218
|
+
## Call Signature
|
|
219
|
+
|
|
220
|
+
```ts
|
|
221
|
+
function toUint8Array(
|
|
222
|
+
value,
|
|
223
|
+
padLength?,
|
|
224
|
+
base?): Uint8Array;
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### Parameters
|
|
228
|
+
|
|
229
|
+
### value
|
|
230
|
+
|
|
231
|
+
`string` | `bigint` | `ArrayBufferLike`
|
|
232
|
+
|
|
233
|
+
### padLength?
|
|
234
|
+
|
|
235
|
+
`number`
|
|
236
|
+
|
|
237
|
+
### base?
|
|
238
|
+
|
|
239
|
+
`number`
|
|
240
|
+
|
|
241
|
+
### Returns
|
|
242
|
+
|
|
243
|
+
`Uint8Array`
|
|
244
|
+
|
|
245
|
+
## Call Signature
|
|
246
|
+
|
|
247
|
+
```ts
|
|
248
|
+
function toUint8Array(
|
|
249
|
+
value,
|
|
250
|
+
padLength?,
|
|
251
|
+
base?): undefined | Uint8Array<ArrayBufferLike>;
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
### Parameters
|
|
255
|
+
|
|
256
|
+
### value
|
|
257
|
+
|
|
258
|
+
`undefined` | `string` | `bigint` | `ArrayBufferLike`
|
|
259
|
+
|
|
260
|
+
### padLength?
|
|
261
|
+
|
|
262
|
+
`number`
|
|
263
|
+
|
|
264
|
+
### base?
|
|
265
|
+
|
|
266
|
+
`number`
|
|
267
|
+
|
|
268
|
+
### Returns
|
|
269
|
+
|
|
270
|
+
`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>
|
|
20
271
|
|
|
21
|
-
Coming Soon!
|
|
22
272
|
|
|
23
273
|
Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
|
|
24
274
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xylabs/arraybuffer",
|
|
3
|
-
"version": "4.13.
|
|
3
|
+
"version": "4.13.22",
|
|
4
4
|
"description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"xylabs",
|
|
@@ -41,9 +41,9 @@
|
|
|
41
41
|
"src"
|
|
42
42
|
],
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@xylabs/assert": "^4.13.
|
|
45
|
-
"@xylabs/hex": "^4.13.
|
|
46
|
-
"@xylabs/typeof": "^4.13.
|
|
44
|
+
"@xylabs/assert": "^4.13.22",
|
|
45
|
+
"@xylabs/hex": "^4.13.22",
|
|
46
|
+
"@xylabs/typeof": "^4.13.22"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
49
|
"@xylabs/ts-scripts-yarn3": "^7.0.0",
|