|
Whitebeam Object Definition
|
WbString.Options
Options that configure how some WbString functions behave
Elements
The WbString.Options struct has 9 elements:
Name | Type/Value | Range/Length | Description | key | string | | Optional. Key for the hmac/sign/encrypt operation | keyFmt | string | | Optional, default = text By default the key is simply a text string and is used 'as-is'. Specifying a keyFmt of 'hex' will decode the key as a set of hex-encoded bytes (allowing binary keys). The keyFmt may also be 'base64'. | keyType | string | | Optional, default = text Used by the 'encrypt' function to specify the format of the text key. Values are 'RSA' or 'DSA' | iv | string | | Optional, default = text Initial Vector - used to randomise some encryption and hash values | ivFmt | string | | Optional, default = text 'text' (default), 'hex' or 'base64' | outputFmt | string | | Optional, default = base64 'base64' (default), 'hex', 'bytes' - 'bytes' returns a JavaScript array of numbers representing the bytes to the encoded or encrypted entity. | isOrdinaryFile | bool | | Required. true if the referenced path is file | isSymbolicLink | bool | | Required. true if the referenced path is a symbolic link | fileSize | number | | Required. the file system reported size of the referenced object |
Remarks
Options that configure how some WbString functions behave
|
|
(loadtime : 17ms) |