new Format()
Format
is used to format Object
s into String
s using
a standardized formatting pattern language.
Currently this implementation of Format
is limited to processing
Lexicon patterns.
This Constructor shouldn't be invoked directly. Please use the make()
methods to create an instance of a Format
.
Extends
Members
-
<static> DEFAULT :baja.Format
-
Default Format instance.
Type:
-
valueOf
-
Return the inner value of the
Format
.- Overrides:
Methods
-
<static> format(obj)
-
Format the specified object using the format pattern.
This method can take an object literal or a single pattern
String
argument.Parameters:
Name Type Description obj
Object Properties
Name Type Argument Description pattern
String the format pattern to process.
display
Boolean <optional>
if true, the display string of a Property value is used.
If false, thetoString
version of a Property value is used.
By default, this value is true (in BajaScript, most of the time
we're dealing with mounted Components in a Proxy Component Space).ok
function <optional>
(Deprecated: use Promise) the ok callback
called when the Format string has been processed. The resultant String
will be passed to this function as an argumentfail
function <optional>
(Deprecated: use Promise) the fail callback
called if there's a fatal error processing the format.- To Do:
-
- add example
Returns:
- Type
- Promise.<string>
-
<static> make( [pattern])
-
Make a
Format
.Parameters:
Name Type Argument Description pattern
String <optional>
the
Format
PatternString
.Returns:
- Type
- baja.Format
-
decodeAsync(str [, batch])
-
The string encoding of certain Simples may include Type information, or
other data that may be require asynchronous operations to decode. BOX is
designed to handle these situations when decoding data from the station,
but when user code needs to decode string-encoded Simples directly, prefer
this method as it gives the individual Simple a chance to import Types,
etc. to ensure that the decoded Simple is fully correct.The default implementation just returns
decodeFromString
directly.Parameters:
Name Type Argument Description str
string batch
baja.comm.Batch <optional>
optional batch to use
- Inherited From:
Returns:
may return the Simple instance
directly, or a Promise resolving to same - so wrap inPromise.resolve()
if unsure.- Type
- baja.Simple | Promise.<baja.Simple>
-
decodeFromString(str)
-
Decode a
String
to aFormat
.Parameters:
Name Type Description str
String - Overrides:
Returns:
- Type
- baja.Format
-
encodeToString()
-
Encode
Format
to aString
.- Overrides:
Returns:
- Type
- String
-
equals(obj)
-
Equality test.
Parameters:
Name Type Description obj
- Inherited From:
Returns:
- Type
- Boolean
-
equivalent(obj)
-
Equivalence test.
equivalent()
is used to compare if two Objects have equivalent
state, but might not want to return true for equals since it
it has implied semantics for many operations. The default
implementation returns the result of baja.Object#equals.Parameters:
Name Type Description obj
- Inherited From:
Returns:
- Type
- Boolean
-
format( [obj])
-
Format the specified object using the format pattern.
Parameters:
Name Type Argument Description obj
Object <optional>
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) the ok callback called
when the Format string has been processed. The resultant String will be
passed to this function as an argumentfail
function <optional>
(Deprecated: use Promise) the fail callback
called if there's a fatal error processing the format.- See:
Returns:
- Type
- Promise.<String>
-
getAgents( [is], batch)
-
Returns a promise that resolves to the agent list for this Object.
Parameters:
Name Type Argument Description is
Array.<String> <optional>
An optional array of filters to add to the
agent query.batch
baja.comm.Batch An optional object used to batch network
calls together.- Inherited From:
- See:
Returns:
A promise that will resolve with the Agent Info.
- Type
- Promise
-
getIcon()
-
Return the Object's Icon.
- Inherited From:
Returns:
- Type
- baja.Icon
-
getType()
-
Get the type of this instance.
- Inherited From:
Returns:
- Type
- Type
-
make( [pattern])
-
Make a
Format
.Parameters:
Name Type Argument Description pattern
String <optional>
the
Format
PatternString
.- Overrides:
Returns:
- Type
- baja.Format
-
newCopy( [exact])
-
Every value may be cloned using the
newCopy
method.Please note that
Simple
s are immutable so they don't
allocate a new instance.Parameters:
Name Type Argument Description exact
Boolean <optional>
true if an exact copy of the value should be
made (only valid in the Component architecture).- Inherited From:
- See:
Returns:
a copy of the value (or the same instance if the value is a
Simple
). -
toString()
-
Return a
String
representation of theFormat
.- Overrides:
Returns:
- Type
- String