From ec098df684340da94b692ab09ede810a8603f232 Mon Sep 17 00:00:00 2001 From: m1ga Date: Sat, 20 Aug 2022 15:43:28 +0200 Subject: [PATCH 1/2] skip property --- package.json | 2 +- readme.md | 16 +++++++++++----- reste.js | 10 +++++++++- 3 files changed, 21 insertions(+), 7 deletions(-) diff --git a/package.json b/package.json index 0656a7a..679bdf4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "reste", - "version": "1.6.0", + "version": "1.7.0", "description": "A JavaScript REST / API helper for Titanium with Alloy Models/Collections support", "titaniumManifest": { "guid": "afafe8b0-b93b-771c-a9e5-4e71db81b9ff" diff --git a/readme.md b/readme.md index da5d309..868de60 100644 --- a/readme.md +++ b/readme.md @@ -141,11 +141,11 @@ api.config({ A couple of useful hooks or events can be used within your RESTe global configuration. Those hooks will happen before specific calls are made. They will be executed before any request is sent allowing you to a) change the parameters or b) stop the call happening. -beforePost: +#### beforePost: This one is quite useful if you need to change the parameters which are going to be used for the request. You might for example -- if you're using Parse Server -- want to strip out certain parameters from models before sending them. -Example: +**Example:** ```javascript { ... @@ -156,11 +156,12 @@ Example: ... } ``` -beforeSend: -These are similar to beforeSend but works for all requests (GET, PUT, DELETE, POST). If you specify both beforePost and beforeLoad then beforePost will go first, then beforeSend. +#### beforeSend: -Example: +These are similar to beforeSend but works for all requests (GET, PUT, DELETE, POST). If you specify both `beforePost` and `beforeLoad` then `beforePost` will go first, then `beforeSend`. Inside `beforeSend` or `beforePost` you can call the `callback()` method with `skip:true` so it will still fire your `success` callback but _without_ making the API call. Use this e.g. to load offline fallback data inside your `success` method: + +**Example:** ```javascript { ... @@ -169,6 +170,11 @@ Example: callback(data); } else { alert("No internet connection!"); + callback({ + skip: true, + error: "no_internet" + }); + // will call your success method and pass `error:no_internet` to it } }, ... diff --git a/reste.js b/reste.js index 687b0b2..97378a9 100644 --- a/reste.js +++ b/reste.js @@ -179,11 +179,19 @@ function main() { if (args.method === 'POST' && typeof beforePost === 'function') { beforePost(args.params, (e) => { + if (e.skip) { + onLoad(e); + return; + } args.params = e; send(); }); } else if (typeof beforeSend === 'function') { beforeSend(args.params, (e) => { + if (e.skip) { + onLoad(e); + return; + } args.params = e; send(); }); @@ -581,4 +589,4 @@ function main() { return reste; } -module.exports = main; \ No newline at end of file +module.exports = main; From afe9e8170b7b20c22eb0f2b36b33cca7e3a8e51c Mon Sep 17 00:00:00 2001 From: m1ga Date: Sat, 20 Aug 2022 15:46:36 +0200 Subject: [PATCH 2/2] skip property --- readme.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/readme.md b/readme.md index 868de60..e2112e6 100644 --- a/readme.md +++ b/readme.md @@ -150,8 +150,8 @@ This one is quite useful if you need to change the parameters which are going to { ... beforePost: function(params, callback) { - params.something = 'else'; - callback(params); + params.something = 'else'; + callback(params); }, ... } @@ -166,18 +166,18 @@ These are similar to beforeSend but works for all requests (GET, PUT, DELETE, PO { ... beforeSend: function(data, callback) { - if (Ti.Network.online) { - callback(data); - } else { - alert("No internet connection!"); - callback({ - skip: true, - error: "no_internet" - }); - // will call your success method and pass `error:no_internet` to it - } - }, - ... + if (Ti.Network.online) { + callback(data); + } else { + alert("No internet connection!"); + callback({ + skip: true, + error: "no_internet" + }); + // will call your success method and pass `error:no_internet` to it + } + }, + ... } ``` ### Errors @@ -283,13 +283,13 @@ Here's a **PUT** request example, passing an id (you'd need to ensure you have a ```javascript api.updateVideo({ - objectId: "123", - body: { - categoryId: 2, - name: "My Video2" - } + objectId: "123", + body: { + categoryId: 2, + name: "My Video2" + } }, function(video) { - // do stuff with the video + // do stuff with the video }); ```