Sometimes you need to submit params that are not standard jsonapi params. One great example would be
+https://yourdomain.com/users?debug=true which is not a param for the UserResource you may have, but
+might enable functionality in your controller as needed.
+
+
Invoking it is pretty straightforward, just invoke extraParams and pass in params and values you wish
+to add to your API call when executed.
+
+
YourRecord.extraParams({debug:true})
+
+
One common way to use this globally is to put this into a base class so it can be chained as part of
+every resource.
+
+
+
+ Typescript
+
+
+ Javascript
+
+
+
+
+
+
@Model
+ exportclassApplicationRecordextendsSpraypaintBase{
+ staticwithDebug<TextendsApplicationRecord>():Scope<T>{
+ returnthis.extraParams({debug:true})asScope<T>;
+ }
+ }
+ // unfortunately you will need to pass in the
+ // implementing class' type as a generic
+ UserRecord.withDebug<UserRecord>().all()
+
diff --git a/js/extra-params.md b/js/extra-params.md
new file mode 100644
index 0000000..afd46e6
--- /dev/null
+++ b/js/extra-params.md
@@ -0,0 +1,47 @@
+---
+layout: page
+---
+
+{% include js-header.html %}
+{% include js-toc.html %}
+
+
+### Extra Params
+
+Sometimes you need to submit params that are not standard jsonapi params. One great example would be
+`https://yourdomain.com/users?debug=true` which is not a param for the `UserResource` you may have, but
+might enable functionality in your controller as needed.
+
+Invoking it is pretty straightforward, just invoke `extraParams` and pass in params and values you wish
+to add to your API call when executed.
+
+
+{% highlight typescript %}
+YourRecord.extraParams({ debug: true })
+{% endhighlight %}
+
+One common way to use this globally is to put this into a base class so it can be chained as part of
+every resource.
+
+{% include js-code-tabs.html %}
+
+ {% highlight typescript %}
+ @Model
+ export class ApplicationRecord extends SpraypaintBase {
+ static withDebug(): Scope {
+ return this.extraParams({ debug: true }) as Scope;
+ }
+ }
+ // unfortunately you will need to pass in the
+ // implementing class' type as a generic
+ UserRecord.withDebug().all()
+ {% endhighlight %}
+ {% highlight javascript %}
+ const ApplicationRecord = SpraypaintBase.extend({
+ static: {
+ withDebug: () => this.extraParams({ debug: true });
+ }
+ })
+ UserRecord.withDebug().all()
+ {% endhighlight %}
+
+
+