Whitebeam Object Definition

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

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
keystring  Optional. Key for the hmac/sign/encrypt operation
keyFmtstring  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'.
keyTypestring  Optional, default = text
Used by the 'encrypt' function to specify the format of the text key. Values are 'RSA' or 'DSA'
ivstring  Optional, default = text
Initial Vector - used to randomise some encryption and hash values
ivFmtstring  Optional, default = text
'text' (default), 'hex' or 'base64'
outputFmtstring  Optional, default = base64
'base64' (default), 'hex', 'bytes' - 'bytes' returns a JavaScript array of numbers representing the bytes to the encoded or encrypted entity.
isOrdinaryFilebool  Required. true if the referenced path is file
isSymbolicLinkbool  Required. true if the referenced path is a symbolic link
fileSizenumber  Required. the file system reported size of the referenced object

Remarks

Options that configure how some WbString functions behave

Whitebeam release 1.3.36
(loadtime : 17ms)