Class: kb.FormattedObservable

Defined in:

src/formatting/formatted-observable.coffee

Instance Method Summary

# (void) destroy() Required clean up function to break cycles, release view models, etc.

Constructor Details

# (ko.observable) constructor(format, args)

Note: the constructor does not return 'this' but a ko.observable

Used to create a new kb.FormattedObservable.

Parameters:

format ( String|ko.observable ) — the format string. Format: "{0} and {1}" where {0} and {1} would be synchronized with the arguments (eg. "Bob and Carol" where {0} is Bob and {1} is Carol)
args ( Array ) — arguments to be passed to the kb.LocaleManager's get() method

Returns:

( ko.observable ) — the constructor does not return 'this' but a ko.observable

Instance Method Details

# (void) destroy()

Required clean up function to break cycles, release view models, etc. Can be called directly, via kb.release(object) or as a consequence of ko.releaseNode(element).