FileRepository (upload)
@ckeditor/ckeditor5-upload/src/filerepository
File repository plugin. A central point for managing file upload.
To use it, first you need an upload adapter. Upload adapter's job is to handle communication with the server
(sending the file and handling server's response). You can use one of the existing plugins introducing upload adapters
(e.g. CloudServicesUploadAdapter
or
CKFinderUploadAdapter
) or write your own one – see
the Custom image upload adapter deep-dive guide.
Then, you can use createLoader()
and the returned
FileLoader
instance to load and upload files.
Filtering
Properties
-
createUploadAdapter : ( FileLoader ) => UploadAdapter | undefined
module:upload/filerepository~FileRepository#createUploadAdapter
A factory function which should be defined before using
FileRepository
.It should return a new instance of
UploadAdapter
that will be used to upload files.FileLoader
instance associated with the adapter will be passed to that function.For more information and example see
UploadAdapter
. -
The editor instance.
Note that most editors implement the
ui
property. However, editors with an external UI (i.e. Bootstrap-based) or a headless editor may not have this property or throw an error when accessing it.Because of above, to make plugins more universal, it is recommended to split features into:
-
Flag indicating whether a plugin is enabled or disabled. A disabled plugin will not transform text.
Plugin can be simply disabled like that:
// Disable the plugin so that no toolbars are visible. editor.plugins.get( 'TextTransformation' ).isEnabled = false;
You can also use
forceDisabled
method. -
loaders : Collection<FileLoader>
module:upload/filerepository~FileRepository#loaders
Collection of loaders associated with this repository.
-
Number of total bytes to upload.
It might be different than the file size because of headers and additional data. It contains
null
if value is not available yet, so it's better to useuploadedPercent
to monitor the progress. -
Number of bytes uploaded.
-
Upload progress in percents.
-
private
_loadersMap : Map<File | Promise<File>, FileLoader>
module:upload/filerepository~FileRepository#_loadersMap
Loaders mappings used to retrieve loaders references.
-
private
_pendingAction : null | PendingAction
module:upload/filerepository~FileRepository#_pendingAction
Reference to a pending action registered in a
PendingActions
plugin while upload is in progress. When there is no upload then value isnull
.
Static properties
-
readonly inherited static
isContextPlugin : false
module:upload/filerepository~FileRepository.isContextPlugin
-
readonly inherited static
isPremiumPlugin : boolean
module:upload/filerepository~FileRepository.isPremiumPlugin
Methods
-
-
inherited
bind( bindProperties ) → MultiBindChain
module:upload/filerepository~FileRepository#bind:MANY_BIND
Binds observable properties to other objects implementing the
Observable
interface.Read more in the dedicated guide covering the topic of property bindings with some additional examples.
Consider two objects: a
button
and an associatedcommand
(bothObservable
).A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
or even shorter:
button.bind( 'isEnabled' ).to( command );
which works in the following way:
button.isEnabled
instantly equalscommand.isEnabled
,- whenever
command.isEnabled
changes,button.isEnabled
will immediately reflect its value.
Note: To release the binding, use
unbind
.You can also "rename" the property in the binding by specifying the new name in the
to()
chain:button.bind( 'isEnabled' ).to( command, 'isWorking' );
It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );
which corresponds to:
button.bind( 'isEnabled' ).to( command ); button.bind( 'value' ).to( command );
The binding can include more than one observable, combining multiple data sources in a custom callback:
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible', ( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
It is also possible to bind to the same property in an array of observables. To bind a
button
to multiple commands (alsoObservables
) so that each and every one of them must be enabled for the button to become enabled, use the following code:button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled', ( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
Parameters
bindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'isEnabled' | 'init' | 'editor' | 'forceDisabled' | 'clearForceDisabled' | 'loaders' | 'createUploadAdapter' | 'uploaded' | 'uploadTotal' | 'uploadedPercent' | 'getLoader' | 'createLoader' | 'destroyLoader'>
Observable properties that will be bound to other observable(s).
Returns
MultiBindChain
The bind chain with the
to()
andtoMany()
methods.
-
inherited
bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, FileRepository[ K1 ], K2, FileRepository[ K2 ]>
module:upload/filerepository~FileRepository#bind:DUAL_BIND
Binds observable properties to other objects implementing the
Observable
interface.Read more in the dedicated guide covering the topic of property bindings with some additional examples.
Consider two objects: a
button
and an associatedcommand
(bothObservable
).A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
or even shorter:
button.bind( 'isEnabled' ).to( command );
which works in the following way:
button.isEnabled
instantly equalscommand.isEnabled
,- whenever
command.isEnabled
changes,button.isEnabled
will immediately reflect its value.
Note: To release the binding, use
unbind
.You can also "rename" the property in the binding by specifying the new name in the
to()
chain:button.bind( 'isEnabled' ).to( command, 'isWorking' );
It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );
which corresponds to:
button.bind( 'isEnabled' ).to( command ); button.bind( 'value' ).to( command );
The binding can include more than one observable, combining multiple data sources in a custom callback:
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible', ( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
It is also possible to bind to the same property in an array of observables. To bind a
button
to multiple commands (alsoObservables
) so that each and every one of them must be enabled for the button to become enabled, use the following code:button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled', ( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
Type parameters
K1
K2
Parameters
bindProperty1 : K1
Observable property that will be bound to other observable(s).
bindProperty2 : K2
Observable property that will be bound to other observable(s).
Returns
DualBindChain<K1, FileRepository[ K1 ], K2, FileRepository[ K2 ]>
The bind chain with the
to()
andtoMany()
methods.
-
inherited
bind( bindProperty ) → SingleBindChain<K, FileRepository[ K ]>
module:upload/filerepository~FileRepository#bind:SINGLE_BIND
Binds observable properties to other objects implementing the
Observable
interface.Read more in the dedicated guide covering the topic of property bindings with some additional examples.
Consider two objects: a
button
and an associatedcommand
(bothObservable
).A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
or even shorter:
button.bind( 'isEnabled' ).to( command );
which works in the following way:
button.isEnabled
instantly equalscommand.isEnabled
,- whenever
command.isEnabled
changes,button.isEnabled
will immediately reflect its value.
Note: To release the binding, use
unbind
.You can also "rename" the property in the binding by specifying the new name in the
to()
chain:button.bind( 'isEnabled' ).to( command, 'isWorking' );
It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );
which corresponds to:
button.bind( 'isEnabled' ).to( command ); button.bind( 'value' ).to( command );
The binding can include more than one observable, combining multiple data sources in a custom callback:
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible', ( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
It is also possible to bind to the same property in an array of observables. To bind a
button
to multiple commands (alsoObservables
) so that each and every one of them must be enabled for the button to become enabled, use the following code:button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled', ( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
Type parameters
K
Parameters
bindProperty : K
Observable property that will be bound to other observable(s).
Returns
SingleBindChain<K, FileRepository[ K ]>
The bind chain with the
to()
andtoMany()
methods.
-
inherited
clearForceDisabled( id ) → void
module:upload/filerepository~FileRepository#clearForceDisabled
Clears forced disable previously set through
forceDisabled
. SeeforceDisabled
.Parameters
id : string
Unique identifier, equal to the one passed in
forceDisabled
call.
Returns
void
-
createLoader( fileOrPromise ) → null | FileLoader
module:upload/filerepository~FileRepository#createLoader
Creates a loader instance for the given file.
Requires
createUploadAdapter
factory to be defined.Parameters
fileOrPromise : File | Promise<File>
Native File object or native Promise object which resolves to a File.
Returns
null | FileLoader
-
Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.
Read more in the dedicated guide covering the topic of decorating methods with some additional examples.
Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.
For example, to cancel the method execution the event can be stopped:
class Foo extends ObservableMixin() { constructor() { super(); this.decorate( 'method' ); } method() { console.log( 'called!' ); } } const foo = new Foo(); foo.on( 'method', ( evt ) => { evt.stop(); }, { priority: 'high' } ); foo.method(); // Nothing is logged.
Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).
It is also possible to change the returned value:
foo.on( 'method', ( evt ) => { evt.return = 'Foo!'; } ); foo.method(); // -> 'Foo'
Finally, it is possible to access and modify the arguments the method is called with:
method( a, b ) { console.log( `${ a }, ${ b }` ); } // ... foo.on( 'method', ( evt, args ) => { args[ 0 ] = 3; console.log( args[ 1 ] ); // -> 2 }, { priority: 'high' } ); foo.method( 1, 2 ); // -> '3, 2'
Parameters
methodName : 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'isEnabled' | 'init' | 'editor' | 'forceDisabled' | 'clearForceDisabled' | 'loaders' | 'createUploadAdapter' | 'uploaded' | 'uploadTotal' | 'uploadedPercent' | 'getLoader' | 'createLoader' | 'destroyLoader'
Name of the method to decorate.
Returns
void
-
inherited
delegate( events ) → EmitterMixinDelegateChain
module:upload/filerepository~FileRepository#delegate
Delegates selected events to another
Emitter
. For instance:emitterA.delegate( 'eventX' ).to( emitterB ); emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
then
eventX
is delegated (fired by)emitterB
andemitterC
along withdata
:emitterA.fire( 'eventX', data );
and
eventY
is delegated (fired by)emitterC
along withdata
:emitterA.fire( 'eventY', data );
Parameters
events : Array<string>
Event names that will be delegated to another emitter.
Returns
-
Destroys the plugin.
Note: This method is optional. A plugin instance does not need to have it defined.
Returns
void
-
destroyLoader( fileOrPromiseOrLoader ) → void
module:upload/filerepository~FileRepository#destroyLoader
Destroys the given loader.
Parameters
fileOrPromiseOrLoader : File | FileLoader | Promise<File>
File or Promise associated with that loader or loader itself.
Returns
void
-
inherited
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]
module:upload/filerepository~FileRepository#fire
Fires an event, executing all callbacks registered for it.
The first parameter passed to callbacks is an
EventInfo
object, followed by the optionalargs
provided in thefire()
method call.Type parameters
Parameters
eventOrInfo : GetNameOrEventInfo<TEvent>
The name of the event or
EventInfo
object if event is delegated.args : TEvent[ 'args' ]
Additional arguments to be passed to the callbacks.
Returns
GetEventInfo<TEvent>[ 'return' ]
By default the method returns
undefined
. However, the return value can be changed by listeners through modification of theevt.return
's property (the event info is the first param of every callback).
-
Disables the plugin.
Plugin may be disabled by multiple features or algorithms (at once). When disabling a plugin, unique id should be passed (e.g. feature name). The same identifier should be used when enabling back the plugin. The plugin becomes enabled only after all features enabled it back.
Disabling and enabling a plugin:
plugin.isEnabled; // -> true plugin.forceDisabled( 'MyFeature' ); plugin.isEnabled; // -> false plugin.clearForceDisabled( 'MyFeature' ); plugin.isEnabled; // -> true
Plugin disabled by multiple features:
plugin.forceDisabled( 'MyFeature' ); plugin.forceDisabled( 'OtherFeature' ); plugin.clearForceDisabled( 'MyFeature' ); plugin.isEnabled; // -> false plugin.clearForceDisabled( 'OtherFeature' ); plugin.isEnabled; // -> true
Multiple disabling with the same identifier is redundant:
plugin.forceDisabled( 'MyFeature' ); plugin.forceDisabled( 'MyFeature' ); plugin.clearForceDisabled( 'MyFeature' ); plugin.isEnabled; // -> true
Note: some plugins or algorithms may have more complex logic when it comes to enabling or disabling certain plugins, so the plugin might be still disabled after
clearForceDisabled
was used.Parameters
id : string
Unique identifier for disabling. Use the same id when enabling back the plugin.
Returns
void
-
getLoader( fileOrPromise ) → null | FileLoader
module:upload/filerepository~FileRepository#getLoader
Returns the loader associated with specified file or promise.
To get loader by id use
fileRepository.loaders.get( id )
.Parameters
fileOrPromise : File | Promise<File>
Native file or promise handle.
Returns
null | FileLoader
-
init() → void
module:upload/filerepository~FileRepository#init
-
inherited
listenTo( emitter, event, callback, [ options ] ) → void
module:upload/filerepository~FileRepository#listenTo:BASE_EMITTER
Registers a callback function to be executed when an event is fired in a specific (emitter) object.
Events can be grouped in namespaces using
:
. When namespaced event is fired, it additionally fires all callbacks for that namespace.// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ). myEmitter.on( 'myGroup', genericCallback ); myEmitter.on( 'myGroup:myEvent', specificCallback ); // genericCallback is fired. myEmitter.fire( 'myGroup' ); // both genericCallback and specificCallback are fired. myEmitter.fire( 'myGroup:myEvent' ); // genericCallback is fired even though there are no callbacks for "foo". myEmitter.fire( 'myGroup:foo' );
An event callback can stop the event and set the return value of the
fire
method.Type parameters
Parameters
emitter : Emitter
The object that fires the event.
event : TEvent[ 'name' ]
The name of the event.
callback : GetCallback<TEvent>
The function to be called on event.
[ options ] : GetCallbackOptions<TEvent>
Additional options.
Returns
void
-
Stops executing the callback on the given event. Shorthand for
this.stopListening( this, event, callback )
.Parameters
event : string
The name of the event.
callback : Function
The function to stop being called.
Returns
void
-
Registers a callback function to be executed when an event is fired.
Shorthand for
this.listenTo( this, event, callback, options )
(it makes the emitter listen on itself).Type parameters
Parameters
event : TEvent[ 'name' ]
The name of the event.
callback : GetCallback<TEvent>
The function to be called on event.
[ options ] : GetCallbackOptions<TEvent>
Additional options.
Returns
void
-
inherited
once( event, callback, [ options ] ) → void
module:upload/filerepository~FileRepository#once
Registers a callback function to be executed on the next time the event is fired only. This is similar to calling
on
followed byoff
in the callback.Type parameters
Parameters
event : TEvent[ 'name' ]
The name of the event.
callback : GetCallback<TEvent>
The function to be called on event.
[ options ] : GetCallbackOptions<TEvent>
Additional options.
Returns
void
-
Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.
It accepts a single object literal containing key/value pairs with properties to be set.
This method throws the
observable-set-cannot-override
error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means thatfoo.set( 'bar', 1 )
may be slightly slower thanfoo.bar = 1
.In TypeScript, those properties should be declared in class using
declare
keyword. In example:public declare myProp1: number; public declare myProp2: string; constructor() { this.set( { 'myProp1: 2, 'myProp2: 'foo' } ); }
Parameters
values : object
An object with
name=>value
pairs.
Returns
void
-
Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.
This method throws the
observable-set-cannot-override
error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means thatfoo.set( 'bar', 1 )
may be slightly slower thanfoo.bar = 1
.In TypeScript, those properties should be declared in class using
declare
keyword. In example:public declare myProp: number; constructor() { this.set( 'myProp', 2 ); }
Type parameters
K
Parameters
name : K
The property's name.
value : FileRepository[ K ]
The property's value.
Returns
void
-
inherited
stopDelegating( [ event ], [ emitter ] ) → void
module:upload/filerepository~FileRepository#stopDelegating
Stops delegating events. It can be used at different levels:
- To stop delegating all events.
- To stop delegating a specific event to all emitters.
- To stop delegating a specific event to a specific emitter.
Parameters
[ event ] : string
The name of the event to stop delegating. If omitted, stops it all delegations.
[ emitter ] : Emitter
(requires
event
) The object to stop delegating a particular event to. If omitted, stops delegation ofevent
to all emitters.
Returns
void
-
inherited
stopListening( [ emitter ], [ event ], [ callback ] ) → void
module:upload/filerepository~FileRepository#stopListening:BASE_STOP
Stops listening for events. It can be used at different levels:
- To stop listening to a specific callback.
- To stop listening to a specific event.
- To stop listening to all events fired by a specific object.
- To stop listening to all events fired by all objects.
Parameters
[ emitter ] : Emitter
The object to stop listening to. If omitted, stops it for all objects.
[ event ] : string
(Requires the
emitter
) The name of the event to stop listening to. If omitted, stops it for all events fromemitter
.[ callback ] : Function
(Requires the
event
) The function to be removed from the call list for the givenevent
.
Returns
void
-
Removes the binding created with
bind
.// Removes the binding for the 'a' property. A.unbind( 'a' ); // Removes bindings for all properties. A.unbind();
Parameters
unbindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'isEnabled' | 'init' | 'editor' | 'forceDisabled' | 'clearForceDisabled' | 'loaders' | 'createUploadAdapter' | 'uploaded' | 'uploadTotal' | 'uploadedPercent' | 'getLoader' | 'createLoader' | 'destroyLoader'>
Observable properties to be unbound. All the bindings will be released if no properties are provided.
Returns
void
-
private
_updatePendingAction() → void
module:upload/filerepository~FileRepository#_updatePendingAction
Events
-
inherited
change:isEnabled( eventInfo, name, value, oldValue )
module:upload/filerepository~FileRepository#event:change:isEnabled
Fired when the
isEnabled
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
isEnabled
).value : boolean
New value of the
isEnabled
property with given key ornull
, if operation should remove property.oldValue : boolean
Old value of the
isEnabled
property with given key ornull
, if property was not set before.
-
change:uploadTotal( eventInfo, name, value, oldValue )
module:upload/filerepository~FileRepository#event:change:uploadTotal
Fired when the
uploadTotal
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
uploadTotal
).value : null | number
New value of the
uploadTotal
property with given key ornull
, if operation should remove property.oldValue : null | number
Old value of the
uploadTotal
property with given key ornull
, if property was not set before.
-
change:uploaded( eventInfo, name, value, oldValue )
module:upload/filerepository~FileRepository#event:change:uploaded
Fired when the
uploaded
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
uploaded
).value : number
New value of the
uploaded
property with given key ornull
, if operation should remove property.oldValue : number
Old value of the
uploaded
property with given key ornull
, if property was not set before.
-
change:uploadedPercent( eventInfo, name, value, oldValue )
module:upload/filerepository~FileRepository#event:change:uploadedPercent
Fired when the
uploadedPercent
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
uploadedPercent
).value : number
New value of the
uploadedPercent
property with given key ornull
, if operation should remove property.oldValue : number
Old value of the
uploadedPercent
property with given key ornull
, if property was not set before.
-
inherited
change:{property}( eventInfo, name, value, oldValue )
module:upload/filerepository~FileRepository#event:change:{property}
Fired when a property changed value.
observable.set( 'prop', 1 ); observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => { console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` ); } ); observable.prop = 2; // -> 'prop has changed from 1 to 2'
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
The property name.
value : TValue
The new property value.
oldValue : TValue
The previous property value.
-
inherited
set:isEnabled( eventInfo, name, value, oldValue )
module:upload/filerepository~FileRepository#event:set:isEnabled
Fired when the
isEnabled
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
isEnabled
).value : boolean
New value of the
isEnabled
property with given key ornull
, if operation should remove property.oldValue : boolean
Old value of the
isEnabled
property with given key ornull
, if property was not set before.
-
set:uploadTotal( eventInfo, name, value, oldValue )
module:upload/filerepository~FileRepository#event:set:uploadTotal
Fired when the
uploadTotal
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
uploadTotal
).value : null | number
New value of the
uploadTotal
property with given key ornull
, if operation should remove property.oldValue : null | number
Old value of the
uploadTotal
property with given key ornull
, if property was not set before.
-
set:uploaded( eventInfo, name, value, oldValue )
module:upload/filerepository~FileRepository#event:set:uploaded
Fired when the
uploaded
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
uploaded
).value : number
New value of the
uploaded
property with given key ornull
, if operation should remove property.oldValue : number
Old value of the
uploaded
property with given key ornull
, if property was not set before.
-
set:uploadedPercent( eventInfo, name, value, oldValue )
module:upload/filerepository~FileRepository#event:set:uploadedPercent
Fired when the
uploadedPercent
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
uploadedPercent
).value : number
New value of the
uploadedPercent
property with given key ornull
, if operation should remove property.oldValue : number
Old value of the
uploadedPercent
property with given key ornull
, if property was not set before.
-
inherited
set:{property}( eventInfo, name, value, oldValue )
module:upload/filerepository~FileRepository#event:set:{property}
Fired when a property value is going to be set but is not set yet (before the
change
event is fired).You can control the final value of the property by using the event's
return
property.observable.set( 'prop', 1 ); observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => { console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` ); console.log( `Current property value is ${ observable[ propertyName ] }` ); // Let's override the value. evt.return = 3; } ); observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => { console.log( `Value has changed from ${ oldValue } to ${ newValue }` ); } ); observable.prop = 2; // -> 'Value is going to be changed from 1 to 2' // -> 'Current property value is 1' // -> 'Value has changed from 1 to 3'
Note: The event is fired even when the new value is the same as the old value.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
The property name.
value : TValue
The new property value.
oldValue : TValue
The previous property value.
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.