Goto Chapter: Top 1 2 3 4 5 6 7 8 9 10 Ind
 [Top of Book]  [Contents]   [Previous Chapter]   [Next Chapter] 

10 Francy Util
 10.1 Operations

10 Francy Util

Utility functions used across the package.

10.1 Operations

In this section we show all Francy Util Operations. Contains utility methods to handle Object printing/viewing, Sanitizing, etc.

10.1-1 JUPYTER_ViewString
‣ JUPYTER_ViewString( arg )( operation )

Returns: String

This method will pretty print in jupyter environment.

10.1-2 Sanitize
‣ Sanitize( IsObject )( operation )

Returns: rec

This method will clone an Object and return a sanitized record. It traverses all the components sanitizing when appropriate. Sanitizing in this context means: replace everything that can't be converted into JSON, with its string representation!

10.1-3 MergeObjects
‣ MergeObjects( IsFrancyObject, IsFrancyObject )( operation )

Returns: rec

This method will merge the properties of 2 IsFrancyObjects into one rec.

10.1-4 GenerateID
‣ GenerateID( )( operation )

Returns: IsString

This method will generate a sequential ID to be used as object identifier. These IDs are used to identify the objects between the client and the server, and are crucial for the communication between both.

 [Top of Book]  [Contents]   [Previous Chapter]   [Next Chapter] 
Goto Chapter: Top 1 2 3 4 5 6 7 8 9 10 Ind

generated by GAPDoc2HTML