aboutsummaryrefslogtreecommitdiff
path: root/node_modules/@tokenizer/token/index.d.ts
diff options
context:
space:
mode:
authorMinteck <freeziv.ytb@gmail.com>2021-03-07 18:29:17 +0100
committerMinteck <freeziv.ytb@gmail.com>2021-03-07 18:29:17 +0100
commit0f79e708bf07721b73ea41e5d341be08e8ea4dce (patch)
treef3c63cd6a9f4ef0b26f95eec6a031600232e80c8 /node_modules/@tokenizer/token/index.d.ts
downloadelectrode-0f79e708bf07721b73ea41e5d341be08e8ea4dce.tar.gz
electrode-0f79e708bf07721b73ea41e5d341be08e8ea4dce.tar.bz2
electrode-0f79e708bf07721b73ea41e5d341be08e8ea4dce.zip
Initial commit
Diffstat (limited to 'node_modules/@tokenizer/token/index.d.ts')
-rw-r--r--node_modules/@tokenizer/token/index.d.ts29
1 files changed, 29 insertions, 0 deletions
diff --git a/node_modules/@tokenizer/token/index.d.ts b/node_modules/@tokenizer/token/index.d.ts
new file mode 100644
index 0000000..828916e
--- /dev/null
+++ b/node_modules/@tokenizer/token/index.d.ts
@@ -0,0 +1,29 @@
+/**
+ * Read-only token
+ * See https://github.com/Borewit/strtok3 for more information
+ */
+export interface IGetToken<T> {
+
+ /**
+ * Length of encoded token in bytes
+ */
+ len: number;
+
+ /**
+ * Decode value from buffer at offset
+ * @param buffer - Buffer to read the decoded value from
+ * @param offset - Decode offset
+ * @return Decoded value
+ */
+ get(buffer: Buffer, offset: number): T;
+}
+
+export interface IToken<T> extends IGetToken<T> {
+ /**
+ * Encode value to buffer
+ * @param buffer - Buffer to write the encoded value to
+ * @param offset - Buffer write offset
+ * @param value - Value to decode of type T
+ */
+ put(buffer: Buffer, offset: number, value: T): number
+}