mirror of
https://github.com/element-hq/element-web.git
synced 2024-12-11 10:32:09 +03:00
a5f3318f3b
This is a relatively obvious dispatch action that doesn't require a lot of complicated type definitions, so should be a good candidate to prove the thing works. If for some reason the thing stops working, we've done something wrong.
This also adds a bit of generic types to the dispatch call so we don't confuse the tsx parser by using `dis.dispatch(<ViewUserPayload>{...})` as it thinks that's supposed to be a component. We still get type safety, and the thing remains happy with the generics approach.
74 lines
2.7 KiB
TypeScript
74 lines
2.7 KiB
TypeScript
/*
|
|
Copyright 2015, 2016 OpenMarket Ltd
|
|
Copyright 2017 New Vector Ltd
|
|
Copyright 2020 The Matrix.org Foundation C.I.C.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import { Dispatcher } from "flux";
|
|
import { Action } from "./actions";
|
|
import { ActionPayload, AsyncActionPayload } from "./payloads";
|
|
|
|
/**
|
|
* A dispatcher for ActionPayloads (the default within the SDK).
|
|
*/
|
|
export class MatrixDispatcher extends Dispatcher<ActionPayload> {
|
|
/**
|
|
* Dispatches an event on the dispatcher's event bus.
|
|
* @param {ActionPayload} payload Required. The payload to dispatch.
|
|
* @param {boolean=false} sync Optional. Pass true to dispatch
|
|
* synchronously. This is useful for anything triggering
|
|
* an operation that the browser requires user interaction
|
|
* for. Default false (async).
|
|
*/
|
|
dispatch<T extends ActionPayload>(payload: T, sync = false) {
|
|
if (payload instanceof AsyncActionPayload) {
|
|
payload.fn((action: ActionPayload) => {
|
|
this.dispatch(action, sync);
|
|
});
|
|
return;
|
|
}
|
|
|
|
if (sync) {
|
|
super.dispatch(payload);
|
|
} else {
|
|
// Unless the caller explicitly asked for us to dispatch synchronously,
|
|
// we always set a timeout to do this: The flux dispatcher complains
|
|
// if you dispatch from within a dispatch, so rather than action
|
|
// handlers having to worry about not calling anything that might
|
|
// then dispatch, we just do dispatches asynchronously.
|
|
setTimeout(super.dispatch.bind(this, payload), 0);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Shorthand for dispatch({action: Action.WHATEVER}, sync). No additional
|
|
* properties can be included with this version.
|
|
* @param {Action} action The action to dispatch.
|
|
* @param {boolean=false} sync Whether the dispatch should be sync or not.
|
|
* @see dispatch(action: ActionPayload, sync: boolean)
|
|
*/
|
|
fire(action: Action, sync = false) {
|
|
this.dispatch({action}, sync);
|
|
}
|
|
}
|
|
|
|
export const defaultDispatcher = new MatrixDispatcher();
|
|
|
|
const anyGlobal = <any>global;
|
|
if (!anyGlobal.mxDispatcher) {
|
|
anyGlobal.mxDispatcher = defaultDispatcher;
|
|
}
|
|
|
|
export default defaultDispatcher;
|