aboutsummaryrefslogtreecommitdiff
path: root/node_modules/@tokenizer/token/index.d.ts
blob: 828916e9a983ef9dc8c9dfe94bbf8633116b0aad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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
}