index.d.ts 3.27 KB
   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
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
type Message = string | number[] | ArrayBuffer | Uint8Array;

interface Hasher {
/**
* Update hash
*
* @param message The message you want to hash.
*/
update(message: Message): Hasher;

/**
* Return hash in hex string.
*/
hex(): string;

/**
* Return hash in hex string.
*/
toString(): string;

/**
* Return hash in ArrayBuffer.
*/
arrayBuffer(): ArrayBuffer;

/**
* Return hash in integer array.
*/
digest(): number[];

/**
* Return hash in integer array.
*/
array(): number[];

/**
* Return hash in base64 string.
*/
base64(): string;
}

interface Hmac {
/**
* Computes a Hash-based message authentication code (HMAC) using a secret key
*
* @param secretKey The Secret Key
* @param message The message you want to hash.
*/
(secretKey: Message, message: Message): string;

/**
* Create a hash object using a secret key.
*
* @param secretKey The Secret Key
*/
create(secretKey: Message): Hasher;

/**
* Create a hash object and hash message using a secret key
*
* @param secretKey The Secret Key
* @param message The message you want to hash.
*/
update(secretKey: Message, message: Message): Hasher;

/**
* Return hash in hex string.
*
* @param secretKey The Secret Key
* @param message The message you want to hash.
*/
hex(secretKey: Message, message: Message): string;

/**
* Return hash in ArrayBuffer.
*
* @param secretKey The Secret Key
* @param message The message you want to hash.
*/
arrayBuffer(secretKey: Message, message: Message): ArrayBuffer;

/**
* Return hash in integer array.
*
* @param secretKey The Secret Key
* @param message The message you want to hash.
*/
digest(secretKey: Message, message: Message): number[];

/**
* Return hash in integer array.
*
* @param secretKey The Secret Key
* @param message The message you want to hash.
*/
array(secretKey: Message, message: Message): number[];

/**
* Return hash in base64 string.
*
* @param secretKey The Secret Key
* @param message The message you want to hash.
*/
base64(secretKey: Message, message: Message): string;
}

interface Hash {
/**
* Hash and return hex string.
*
* @param message The message you want to hash.
*/
(message: Message): string;

/**
* Create a hash object.
*/
create(): Hasher;

/**
* Create a hash object and hash message.
*
* @param message The message you want to hash.
*/
update(message: Message): Hasher;

/**
* Return hash in hex string.
*
* @param message The message you want to hash.
*/
hex(message: Message): string;

/**
* Return hash in ArrayBuffer.
*
* @param message The message you want to hash.
*/
arrayBuffer(message: Message): ArrayBuffer;

/**
* Return hash in integer array.
*
* @param message The message you want to hash.
*/
digest(message: Message): number[];

/**
* Return hash in integer array.
*
* @param message The message you want to hash.
*/
array(message: Message): number[];

/**
* Return hash in base64 string.
*
* @param message The message you want to hash.
*/
base64(message: Message): string;

/**
* HMAC interface
*/
hmac: Hmac;
}

export var md5: Hash;