Skip to content

Jsdoc r63766 follow-up #13650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
afercia wants to merge 2 commits into from
Closed

Jsdoc r63766 follow-up #13650

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77c135e
Improve options params in wp api.js file.
afercia Sep 21, 2026
1fb723f
Improve documentation of sync functions in wp api.js file.
afercia Sep 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions src/js/_enqueues/wp/api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -866,12 +866,14 @@
},

/**
* Set nonce header before every Backbone sync.
* Sets a nonce header before every Backbone sync.
*
* @param {string} method The CRUD method ("create", "read", "update", or "delete") to be performed.
* @param {Backbone.Model} model The model to be synced.
* @param {Object} options Additional options for the sync.
* @return {*}.
* @param {string} method The CRUD method ("create", "read", "update", or "delete") to be performed.
* @param {Backbone.Model} model The model to be synced.
* @param {Object} options Additional options for the sync.
* @param {Function} [options.beforeSend] A function to be called before sending the request.
* @param {Function} [options.complete] A function to be called when the request completes.
* @return {JQuery.Promise} A promise that resolves when the sync operation completes.
*/
sync: function( method, model, options ) {
var beforeSend;
Expand Down Expand Up @@ -1027,14 +1029,18 @@
},

/**
* Extend Backbone.Collection.sync to add nonce and pagination support.
* Extends Backbone.Collection.sync to add nonce and pagination support.
*
* Set nonce header before every Backbone sync.
* Sets a nonce header before every Backbone sync.
*
* @param {string} method The CRUD method ("create", "read", "update", or "delete") to be performed.
* @param {Backbone.Model} model The model to be synced.
* @param {Object} options Additional options for the sync.
* @return {*}.
* @param {string} method The CRUD method ("create", "read", "update", or "delete") to be performed.
* @param {Backbone.Model} model The model to be synced.
* @param {Object} options Additional options for the sync.
* @param {Function} [options.beforeSend] A function to be called before sending the request.
* @param {Function} [options.success] A function to be called when the request succeeds.
* @param {Function} [options.complete] A function to be called when the request completes, regardless of success or failure.
* @param {Object} [options.data] Data to be sent with the request.
* @return {JQuery.Promise} A promise that resolves when the sync operation completes.
*/
sync: function( method, model, options ) {
var beforeSend, success,
Expand Down
Loading