[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

/wp-includes/js/dist/ -> core-data.js (summary)

(no description)

File Size: 4809 lines (148 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 118 functions

  __webpack_require__()
  getDefault()
  getModuleExports()
  _defineProperty()
  _arrayWithoutHoles()
  _nonIterableSpread()
  _toConsumableArray()
  _iterableToArrayLimit()
  _slicedToArray()
  _iterableToArray()
  conservativeMapItem()
  withWeakMapCache()
  receiveItems()
  receiveQueriedItems()
  getQueryParts()
  getQueriedItemsUncached()
  apiFetch()
  controls_select()
  resolveSelect()
  receiveUserQuery()
  receiveCurrentUser()
  addEntities()
  receiveEntityRecords()
  receiveThemeSupports()
  receiveEmbedPreview()
  editEntityRecord()
  undo()
  redo()
  __unstableCreateUndoLevel()
  saveEntityRecord()
  saveEditedEntityRecord()
  receiveUploadPermissions()
  receiveUserPermission()
  receiveAutosaves()
  loadPostTypeEntities()
  loadTaxonomyEntities()
  getKindEntities()
  getMergedItemIds()
  reducer_items()
  terms()
  reducer_users()
  reducer_currentUser()
  reducer_taxonomies()
  themeSupports()
  reducer_entity()
  entitiesConfig()
  reducer_undo()
  embedPreviews()
  userPermissions()
  reducer_autosaves()
  getAuthors()
  getCurrentUser()
  getEntitiesByKind()
  getEntity()
  getEntityRecord()
  getEntityRecords()
  getEntityRecordEdits()
  hasEditsForEntityRecord()
  isAutosavingEntityRecord()
  isSavingEntityRecord()
  getLastEntitySaveError()
  getCurrentUndoOffset()
  getUndoEdit()
  getRedoEdit()
  hasUndo()
  hasRedo()
  getThemeSupports()
  getEmbedPreview()
  isPreviewEmbedFallback()
  hasUploadPermissions()
  canUser()
  getAutosaves()
  getAutosave()
  resolvers_getAuthors()
  resolvers_getCurrentUser()
  resolvers_getEntityRecord()
  resolvers_getEntityRecords()
  resolvers_getThemeSupports()
  resolvers_getEmbedPreview()
  resolvers_hasUploadPermissions()
  resolvers_canUser()
  resolvers_getAutosaves()
  resolvers_getAutosave()
  arrayOf()
  isObjectLike()
  createCache()
  isShallowEqual()
  getRootCache()
  getWeakMapCache()
  clear()
  callSelector()
  _arrayWithHoles()
  _nonIterableRest()
  wrap()
  tryCatch()
  Generator()
  GeneratorFunction()
  GeneratorFunctionPrototype()
  defineIteratorMethods()
  AsyncIterator()
  invoke()
  enqueue()
  callInvokeWithMethodAndArg()
  makeInvokeMethod()
  maybeInvokeDelegate()
  pushTryEntry()
  resetTryEntry()
  Context()
  values()
  doneResult()
  handle()
  _objectSpread()
  _typeof()
  _classCallCheck()
  _defineProperties()
  _createClass()
  getValuePair()
  EquivalentKeyMap()

Functions
Functions that are not part of a class:

__webpack_require__(moduleId)   X-Ref
No description

getDefault()   X-Ref
No description

getModuleExports()   X-Ref
No description

_defineProperty(obj, key, value)   X-Ref
No description

_arrayWithoutHoles(arr)   X-Ref
No description

_nonIterableSpread()   X-Ref
No description

_toConsumableArray(arr)   X-Ref
No description

_iterableToArrayLimit(arr, i)   X-Ref
No description

_slicedToArray(arr, i)   X-Ref
No description

_iterableToArray(iter)   X-Ref
No description

conservativeMapItem(item, nextItem)   X-Ref
Given the current and next item entity, returns the minimally "modified"
result of the next item, preferring value references from the original item
if equal. If all values match, the original item is returned.

param: {Object} item     Original item.
param: {Object} nextItem Next item.
return: {Object} Minimally modified merged item.

withWeakMapCache(fn)   X-Ref
Given a function, returns an enhanced function which caches the result and
tracks in WeakMap. The result is only cached if the original function is
passed a valid object-like argument (requirement for WeakMap key).

param: {Function} fn Original function.
return: {Function} Enhanced caching function.

receiveItems(items)   X-Ref
Returns an action object used in signalling that items have been received.

param: {Array} items Items received.
return: {Object} Action object.

receiveQueriedItems(items)   X-Ref
Returns an action object used in signalling that queried data has been
received.

param: {Array}   items Queried items received.
param: {?Object} query Optional query object.
return: {Object} Action object.

getQueryParts(query)   X-Ref
Given a query object, returns an object of parts, including pagination
details (`page` and `perPage`, or default values). All other properties are
encoded into a stable (idempotent) `stableKey` value.

param: {Object} query Optional query object.
return: {WPQueriedDataQueryParts} Query parts.

getQueriedItemsUncached(state, query)   X-Ref
Returns items for a given query, or null if the items are not known.

param: {Object}  state State object.
param: {?Object} query Optional query.
return: {?Array} Query items.

apiFetch(request)   X-Ref
Trigger an API Fetch request.

param: {Object} request API Fetch Request Object.
return: {Object} control descriptor.

controls_select(selectorName)   X-Ref
Calls a selector using the current state.

param: {string} selectorName Selector name.
param: {Array} args         Selector arguments.
return: {Object} control descriptor.

resolveSelect(selectorName)   X-Ref
Dispatches a control action for triggering a registry select that has a
resolver.

param: {string}  selectorName
param: {Array}   args  Arguments for the select.
return: {Object} control descriptor.

receiveUserQuery(queryID, users)   X-Ref
Returns an action object used in signalling that authors have been received.

param: {string}       queryID Query ID.
param: {Array|Object} users   Users received.
return: {Object} Action object.

receiveCurrentUser(currentUser)   X-Ref
Returns an action used in signalling that the current user has been received.

param: {Object} currentUser Current user object.
return: {Object} Action object.

addEntities(entities)   X-Ref
Returns an action object used in adding new entities.

param: {Array} entities  Entities received.
return: {Object} Action object.

receiveEntityRecords(kind, name, records, query)   X-Ref
Returns an action object used in signalling that entity records have been received.

param: {string}       kind            Kind of the received entity.
param: {string}       name            Name of the received entity.
param: {Array|Object} records         Records received.
param: {?Object}      query           Query Object.
param: {?boolean}     invalidateCache Should invalidate query caches
return: {Object} Action object.

receiveThemeSupports(themeSupports)   X-Ref
Returns an action object used in signalling that the index has been received.

param: {Object} themeSupports Theme support for the current theme.
return: {Object} Action object.

receiveEmbedPreview(url, preview)   X-Ref
Returns an action object used in signalling that the preview data for
a given URl has been received.

param: {string}  url      URL to preview the embed for.
param: {Mixed}   preview  Preview data.
return: {Object} Action object.

editEntityRecord(kind, name, recordId, edits)   X-Ref
Returns an action object that triggers an
edit to an entity record.

param: {string} kind     Kind of the edited entity record.
param: {string} name     Name of the edited entity record.
param: {number} recordId Record ID of the edited entity record.
param: {Object} edits    The edits.
param: {Object} options  Options for the edit.
param: {boolean} options.undoIgnore Whether to ignore the edit in undo history or not.
return: {Object} Action object.

undo()   X-Ref
Action triggered to undo the last edit to
an entity record, if any.


redo()   X-Ref
Action triggered to redo the last undoed
edit to an entity record, if any.


__unstableCreateUndoLevel()   X-Ref
Forces the creation of a new undo level.

return: {Object} Action object.

saveEntityRecord(kind, name, record)   X-Ref
Action triggered to save an entity record.

param: {string} kind    Kind of the received entity.
param: {string} name    Name of the received entity.
param: {Object} record  Record to be saved.
param: {Object} options Saving options.

saveEditedEntityRecord(kind, name, recordId, options)   X-Ref
Action triggered to save an entity record's edits.

param: {string} kind     Kind of the entity.
param: {string} name     Name of the entity.
param: {Object} recordId ID of the record.
param: {Object} options  Saving options.

receiveUploadPermissions(hasUploadPermissions)   X-Ref
Returns an action object used in signalling that Upload permissions have been received.

param: {boolean} hasUploadPermissions Does the user have permission to upload files?
return: {Object} Action object.

receiveUserPermission(key, isAllowed)   X-Ref
Returns an action object used in signalling that the current user has
permission to perform an action on a REST resource.

param: {string}  key       A key that represents the action and REST resource.
param: {boolean} isAllowed Whether or not the user can perform the action.
return: {Object} Action object.

receiveAutosaves(postId, autosaves)   X-Ref
Returns an action object used in signalling that the autosaves for a
post have been received.

param: {number}       postId    The id of the post that is parent to the autosave.
param: {Array|Object} autosaves An array of autosaves or singular autosave object.
return: {Object} Action object.

loadPostTypeEntities()   X-Ref
Returns the list of post type entities.

return: {Promise} Entities promise

loadTaxonomyEntities()   X-Ref
Returns the list of the taxonomies entities.

return: {Promise} Entities promise

getKindEntities(kind)   X-Ref
Loads the kind entities into the store.

param: {string} kind  Kind
return: {Array} Entities

getMergedItemIds(itemIds, nextItemIds, page, perPage)   X-Ref
Returns a merged array of item IDs, given details of the received paginated
items. The array is sparse-like with `undefined` entries where holes exist.

param: {?Array<number>} itemIds     Original item IDs (default empty array).
param: {number[]}       nextItemIds Item IDs to merge.
param: {number}         page        Page of items merged.
param: {number}         perPage     Number of items per page.
return: {number[]} Merged array of item IDs.

reducer_items()   X-Ref
Reducer tracking items state, keyed by ID. Items are assumed to be normal,
where identifiers are common across all queries.

param: {Object} state  Current state.
param: {Object} action Dispatched action.
return: {Object} Next state.

terms()   X-Ref
Reducer managing terms state. Keyed by taxonomy slug, the value is either
undefined (if no request has been made for given taxonomy), null (if a
request is in-flight for given taxonomy), or the array of terms for the
taxonomy.

param: {Object} state  Current state.
param: {Object} action Dispatched action.
return: {Object} Updated state.

reducer_users()   X-Ref
Reducer managing authors state. Keyed by id.

param: {Object} state  Current state.
param: {Object} action Dispatched action.
return: {Object} Updated state.

reducer_currentUser()   X-Ref
Reducer managing current user state.

param: {Object} state  Current state.
param: {Object} action Dispatched action.
return: {Object} Updated state.

reducer_taxonomies()   X-Ref
Reducer managing taxonomies.

param: {Object} state  Current state.
param: {Object} action Dispatched action.
return: {Object} Updated state.

themeSupports()   X-Ref
Reducer managing theme supports data.

param: {Object} state  Current state.
param: {Object} action Dispatched action.
return: {Object} Updated state.

reducer_entity(entityConfig)   X-Ref
Higher Order Reducer for a given entity config. It supports:

- Fetching
- Editing
- Saving

param: {Object} entityConfig  Entity config.
return: {Function} Reducer.

entitiesConfig()   X-Ref
Reducer keeping track of the registered entities.

param: {Object} state  Current state.
param: {Object} action Dispatched action.
return: {Object} Updated state.

reducer_undo()   X-Ref
No description

embedPreviews()   X-Ref
Reducer managing embed preview data.

param: {Object} state  Current state.
param: {Object} action Dispatched action.
return: {Object} Updated state.

userPermissions()   X-Ref
State which tracks whether the user can perform an action on a REST
resource.

param: {Object} state  Current state.
param: {Object} action Dispatched action.
return: {Object} Updated state.

reducer_autosaves()   X-Ref
Reducer returning autosaves keyed by their parent's post id.

param: {Object} state  Current state.
param: {Object} action Dispatched action.
return: {Object} Updated state.

getAuthors(state)   X-Ref
Returns all available authors.

param: {Object} state Data state.
return: {Array} Authors list.

getCurrentUser(state)   X-Ref
Returns the current user.

param: {Object} state Data state.
return: {Object} Current user object.

getEntitiesByKind(state, kind)   X-Ref
Returns whether the entities for the give kind are loaded.

param: {Object} state   Data state.
param: {string} kind  Entity kind.
return: {boolean} Whether the entities are loaded

getEntity(state, kind, name)   X-Ref
Returns the entity object given its kind and name.

param: {Object} state   Data state.
param: {string} kind  Entity kind.
param: {string} name  Entity name.
return: {Object} Entity

getEntityRecord(state, kind, name, key)   X-Ref
Returns the Entity's record object by key.

param: {Object} state  State tree
param: {string} kind   Entity kind.
param: {string} name   Entity name.
param: {number} key    Record's key
return: {Object?} Record.

getEntityRecords(state, kind, name, query)   X-Ref
Returns the Entity's records.

param: {Object}  state  State tree
param: {string}  kind   Entity kind.
param: {string}  name   Entity name.
param: {?Object} query  Optional terms query.
return: {Array} Records.

getEntityRecordEdits(state, kind, name, recordId)   X-Ref
Returns the specified entity record's edits.

param: {Object} state    State tree.
param: {string} kind     Entity kind.
param: {string} name     Entity name.
param: {number} recordId Record ID.
return: {Object?} The entity record's edits.

hasEditsForEntityRecord(state, kind, name, recordId)   X-Ref
Returns true if the specified entity record has edits,
and false otherwise.

param: {Object} state    State tree.
param: {string} kind     Entity kind.
param: {string} name     Entity name.
param: {number} recordId Record ID.
return: {boolean} Whether the entity record has edits or not.

isAutosavingEntityRecord(state, kind, name, recordId)   X-Ref
Returns true if the specified entity record is autosaving, and false otherwise.

param: {Object} state    State tree.
param: {string} kind     Entity kind.
param: {string} name     Entity name.
param: {number} recordId Record ID.
return: {boolean} Whether the entity record is autosaving or not.

isSavingEntityRecord(state, kind, name, recordId)   X-Ref
Returns true if the specified entity record is saving, and false otherwise.

param: {Object} state    State tree.
param: {string} kind     Entity kind.
param: {string} name     Entity name.
param: {number} recordId Record ID.
return: {boolean} Whether the entity record is saving or not.

getLastEntitySaveError(state, kind, name, recordId)   X-Ref
Returns the specified entity record's last save error.

param: {Object} state    State tree.
param: {string} kind     Entity kind.
param: {string} name     Entity name.
param: {number} recordId Record ID.
return: {Object?} The entity record's save error.

getCurrentUndoOffset(state)   X-Ref
Returns the current undo offset for the
entity records edits history. The offset
represents how many items from the end
of the history stack we are at. 0 is the
last edit, -1 is the second last, and so on.

param: {Object} state State tree.
return: {number} The current undo offset.

getUndoEdit(state)   X-Ref
Returns the previous edit from the current undo offset
for the entity records edits history, if any.

param: {Object} state State tree.
return: {Object?} The edit.

getRedoEdit(state)   X-Ref
Returns the next edit from the current undo offset
for the entity records edits history, if any.

param: {Object} state State tree.
return: {Object?} The edit.

hasUndo(state)   X-Ref
Returns true if there is a previous edit from the current undo offset
for the entity records edits history, and false otherwise.

param: {Object} state State tree.
return: {boolean} Whether there is a previous edit or not.

hasRedo(state)   X-Ref
Returns true if there is a next edit from the current undo offset
for the entity records edits history, and false otherwise.

param: {Object} state State tree.
return: {boolean} Whether there is a next edit or not.

getThemeSupports(state)   X-Ref
Return theme supports data in the index.

param: {Object} state Data state.
return: {*}           Index data.

getEmbedPreview(state, url)   X-Ref
Returns the embed preview for the given URL.

param: {Object} state    Data state.
param: {string} url      Embedded URL.
return: {*} Undefined if the preview has not been fetched, otherwise, the preview fetched from the embed preview API.

isPreviewEmbedFallback(state, url)   X-Ref
Determines if the returned preview is an oEmbed link fallback.

WordPress can be configured to return a simple link to a URL if it is not embeddable.
We need to be able to determine if a URL is embeddable or not, based on what we
get back from the oEmbed preview API.

param: {Object} state    Data state.
param: {string} url      Embedded URL.
return: {boolean} Is the preview for the URL an oEmbed link fallback.

hasUploadPermissions(state)   X-Ref
Returns whether the current user can upload media.

Calling this may trigger an OPTIONS request to the REST API via the
`canUser()` resolver.

https://developer.wordpress.org/rest-api/reference/

param: {Object} state Data state.
return: {boolean} Whether or not the user can upload media. Defaults to `true` if the OPTIONS

canUser(state, action, resource, id)   X-Ref
Returns whether the current user can perform the given action on the given
REST resource.

Calling this may trigger an OPTIONS request to the REST API via the
`canUser()` resolver.

https://developer.wordpress.org/rest-api/reference/

param: {Object}   state            Data state.
param: {string}   action           Action to check. One of: 'create', 'read', 'update', 'delete'.
param: {string}   resource         REST resource to check, e.g. 'media' or 'posts'.
param: {string=}  id               Optional ID of the rest resource to check.
return: {boolean|undefined} Whether or not the user can perform the action,

getAutosaves(state, postType, postId)   X-Ref
Returns the latest autosaves for the post.

May return multiple autosaves since the backend stores one autosave per
author for each post.

param: {Object} state    State tree.
param: {string} postType The type of the parent post.
param: {number} postId   The id of the parent post.
return: {?Array} An array of autosaves for the post, or undefined if there is none.

getAutosave(state, postType, postId, authorId)   X-Ref
Returns the autosave for the post and author.

param: {Object} state    State tree.
param: {string} postType The type of the parent post.
param: {number} postId   The id of the parent post.
param: {number} authorId The id of the author.
return: {?Object} The autosave for the post and author.

resolvers_getAuthors()   X-Ref
Requests authors from the REST API.


resolvers_getCurrentUser()   X-Ref
Requests the current user from the REST API.


resolvers_getEntityRecord(kind, name, key)   X-Ref
Requests an entity's record from the REST API.

param: {string} kind   Entity kind.
param: {string} name   Entity name.
param: {number} key    Record's key

resolvers_getEntityRecords(kind, name)   X-Ref
Requests the entity's records from the REST API.

param: {string}  kind   Entity kind.
param: {string}  name   Entity name.
param: {Object?} query  Query Object.

resolvers_getThemeSupports()   X-Ref
Requests theme supports data from the index.


resolvers_getEmbedPreview(url)   X-Ref
Requests a preview from the from the Embed API.

param: {string} url   URL to get the preview for.

resolvers_hasUploadPermissions()   X-Ref
Requests Upload Permissions from the REST API.


resolvers_canUser(action, resource, id)   X-Ref
Checks whether the current user can perform the given action on the given
REST resource.

param: {string}  action   Action to check. One of: 'create', 'read', 'update',
param: {string}  resource REST resource to check, e.g. 'media' or 'posts'.
param: {?string} id       ID of the rest resource to check.

resolvers_getAutosaves(postType, postId)   X-Ref
Request autosave data from the REST API.

param: {string} postType The type of the parent post.
param: {number} postId   The id of the parent post.

resolvers_getAutosave(postType, postId)   X-Ref
Request autosave data from the REST API.

This resolver exists to ensure the underlying autosaves are fetched via
`getAutosaves` when a call to the `getAutosave` selector is made.

param: {string} postType The type of the parent post.
param: {number} postId   The id of the parent post.

arrayOf( value )   X-Ref
Returns the first argument as the sole entry in an array.

param: {*} value Value to return.
return: {Array} Value returned as entry in array.

isObjectLike( value )   X-Ref
Returns true if the value passed is object-like, or false otherwise. A value
is object-like if it can support property assignment, e.g. object or array.

param: {*} value Value to test.
return: {boolean} Whether value is object-like.

createCache()   X-Ref
Creates and returns a new cache object.

return: {Object} Cache object.

isShallowEqual( a, b, fromIndex )   X-Ref
Returns true if entries within the two arrays are strictly equal by
reference from a starting index.

param: {Array}  a         First array.
param: {Array}  b         Second array.
param: {number} fromIndex Index from which to start comparison.
return: {boolean} Whether arrays are shallowly equal.

getRootCache()   X-Ref
Returns the root cache. If WeakMap is supported, this is assigned to the
root WeakMap cache set, otherwise it is a shared instance of the default
cache object.

return: {(WeakMap|Object)} Root cache object.

getWeakMapCache( dependants )   X-Ref
Returns the cache for a given dependants array. When possible, a WeakMap
will be used to create a unique cache for each set of dependants. This
is feasible due to the nature of WeakMap in allowing garbage collection
to occur on entries where the key object is no longer referenced. Since
WeakMap requires the key to be an object, this is only possible when the
dependant is object-like. The root cache is created as a hierarchy where
each top-level key is the first entry in a dependants set, the value a
WeakMap where each key is the next dependant, and so on. This continues
so long as the dependants are object-like. If no dependants are object-
like, then the cache is shared across all invocations.

param: {Array} dependants Selector dependants.
return: {Object} Cache object.

clear()   X-Ref
Resets root memoization cache.


callSelector( )   X-Ref
The augmented selector call, considering first whether dependants have
changed before passing it to underlying memoize function.

param: {Object} source    Source object for derivation.
param: {...*}   extraArgs Additional arguments to pass to selector.
return: {*} Selector result.

_arrayWithHoles(arr)   X-Ref
No description

_nonIterableRest()   X-Ref
No description

wrap(innerFn, outerFn, self, tryLocsList)   X-Ref
No description

tryCatch(fn, obj, arg)   X-Ref
No description

Generator()   X-Ref
No description

GeneratorFunction()   X-Ref
No description

GeneratorFunctionPrototype()   X-Ref
No description

defineIteratorMethods(prototype)   X-Ref
No description

AsyncIterator(generator)   X-Ref
No description

invoke(method, arg, resolve, reject)   X-Ref
No description

enqueue(method, arg)   X-Ref
No description

callInvokeWithMethodAndArg()   X-Ref
No description

makeInvokeMethod(innerFn, self, context)   X-Ref
No description

maybeInvokeDelegate(delegate, context)   X-Ref
No description

pushTryEntry(locs)   X-Ref
No description

resetTryEntry(entry)   X-Ref
No description

Context(tryLocsList)   X-Ref
No description

values(iterable)   X-Ref
No description

doneResult()   X-Ref
No description

handle(loc, caught)   X-Ref
No description

_objectSpread(target)   X-Ref
No description

_typeof(obj)   X-Ref
No description

_classCallCheck(instance, Constructor)   X-Ref
No description

_defineProperties(target, props)   X-Ref
No description

_createClass(Constructor, protoProps, staticProps)   X-Ref
No description

getValuePair(instance, key)   X-Ref
Given an instance of EquivalentKeyMap, returns its internal value pair tuple
for a key, if one exists. The tuple members consist of the last reference
value for the key (used in efficient subsequent lookups) and the value
assigned for the key at the leaf node.

param: {EquivalentKeyMap} instance EquivalentKeyMap instance.
param: {*} key                     The key for which to return value pair.
return: {?Array} Value pair, if exists.

EquivalentKeyMap(iterable)   X-Ref
No description



Generated: Sat Nov 23 20:47:33 2019 Cross-referenced by PHPXref 0.7