Feature Added: type IResourceSchemaKeysDefault

supervillain-software-group · Jul 20, 2018 · 282dfdb · 282dfdb
1 parent 09450c9
commit 282dfdb
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/docs/api/README.md b/docs/api/README.md
@@ -25,6 +25,7 @@
 - [IAxiosResourceInterceptor](#iaxiosresourceinterceptor)
 - [IBuildParamsExtendedRes](#ibuildparamsextendedres)
 - [ICreateAxiosInstanceFromUrl](#icreateaxiosinstancefromurl)
+- [IResourceSchemaKeysDefault](#iresourceschemakeysdefault)
 
 ### Variables
 
@@ -115,6 +116,15 @@
 
 ---
 
+<a id="iresourceschemakeysdefault"></a>
+
+### IResourceSchemaKeysDefault
+
+**ΤIResourceSchemaKeysDefault**: _ "create" &#124; "read" &#124; "readOne" &#124; "remove" &#124; "update"
+_
+
+---
+
 ## Variables
 
 <a id="axiosresourceadditionalprops"></a>

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "axios-rest-resource",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

diff --git a/src/resource.ts b/src/resource.ts
@@ -33,11 +33,13 @@ export interface IAPIMethodSchema {
   url?: string
 }
 
+export type IResourceSchemaKeysDefault = 'create' | 'read' | 'readOne' | 'remove' | 'update'
+
 /**
  * @description
  * Default resource schema used by ResourceBuilder.prototype.build
  */
-export const resourceSchemaDefault = {
+export const resourceSchemaDefault: { [ Key in IResourceSchemaKeysDefault ]: IAPIMethodSchema } = {
   create: {
     method: 'post'
   },