diff options
Diffstat (limited to 'node_modules/@tokenizer/token/index.d.ts')
-rw-r--r-- | node_modules/@tokenizer/token/index.d.ts | 29 |
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 +} |