@wordpress/data
Version:
Data module for WordPress.
29 lines (27 loc) • 930 B
JavaScript
/**
* Internal dependencies
*/
import defaultRegistry from './default-registry';
/**
* Given a store descriptor, returns an object of the store's action creators.
* Calling an action creator will cause it to be dispatched, updating the state value accordingly.
*
* Note: Action creators returned by the dispatch will return a promise when
* they are called.
*
* @param storeNameOrDescriptor The store descriptor. The legacy calling convention of passing
* the store name is also supported.
*
* @example
* ```js
* import { dispatch } from '@wordpress/data';
* import { store as myCustomStore } from 'my-custom-store';
*
* dispatch( myCustomStore ).setPrice( 'hammer', 9.75 );
* ```
* @return Object containing the action creators.
*/
export function dispatch(storeNameOrDescriptor) {
return defaultRegistry.dispatch(storeNameOrDescriptor);
}
//# sourceMappingURL=dispatch.js.map