gitlab-fetch - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0-dev.13830735

CHANGELOG.md

 # Changelog
 
+## develop
+* ~deprecated Deprecate `HooksApi#getHooks`, `#getHook`, `#addHook`, `#editHook` and `#deleteHook`.
+  * Renamed to `#getAll`, `#get`, `#create`, `#edit` and `#delete`.
+  * Original methods will be removed in a future major version.
+
 ## 1.0.0
@@ -4,0 +9,0 @@ * Fix name of `ListProjectParams#order_by` parameter (was `#orderBy`)

lib/apis/hooks.d.ts

@@ -19,9 +19,19 @@ import { AbstractApi, Config } from '../common';
 export declare class HooksApi extends AbstractApi {
+    /** @deprecated Use #getAll instead */
+    getHooks: (params?: PaginationParams) => Promise<Hook[]>;
+    /** @deprecated Use #get instead */
+    getHook: (hookId: number) => Promise<Hook>;
+    /** @deprecated Use #create instead */
+    addHook: (url: string, params?: AddHookParams) => Promise<Hook>;
+    /** @deprecated Use #edit instead */
+    editHook: (hookId: number, url: string, params?: EditHookParams) => Promise<Hook>;
+    /** @deprecated Use #delete instead */
+    deleteHook: (hookId: number) => Promise<void>;
     constructor(config: Config, id: number);
     constructor(config: Config, namespace: string, projectName: string);
-    getHooks(params?: PaginationParams): Promise<Hook[]>;
-    getHook(hookId: number): Promise<Hook>;
-    addHook(url: string, params?: AddHookParams): Promise<Hook>;
-    editHook(hookId: number, url: string, params?: EditHookParams): Promise<Hook>;
-    deleteHook(hookId: number): Promise<void>;
+    getAll(params?: PaginationParams): Promise<Hook[]>;
+    get(hookId: number): Promise<Hook>;
+    create(url: string, params?: AddHookParams): Promise<Hook>;
+    edit(hookId: number, url: string, params?: EditHookParams): Promise<Hook>;
+    delete(hookId: number): Promise<void>;
 }

lib/apis/hooks.js

@@ -8,16 +8,26 @@ "use strict";
         super(config, `/projects/${project_1.ProjectApi.toProjectId(idOrNamespace, projectName)}/hooks`);
+        /** @deprecated Use #getAll instead */
+        this.getHooks = this.getAll;
+        /** @deprecated Use #get instead */
+        this.getHook = this.get;
+        /** @deprecated Use #create instead */
+        this.addHook = this.create;
+        /** @deprecated Use #edit instead */
+        this.editHook = this.edit;
+        /** @deprecated Use #delete instead */
+        this.deleteHook = this.delete;
     }
-    getHooks(params = {}) {
+    getAll(params = {}) {
         return this.fetch('GET', undefined, params);
     }
-    getHook(hookId) {
+    get(hookId) {
         return this.fetch('GET', `/${hookId}`);
     }
-    addHook(url, params = {}) {
+    create(url, params = {}) {
         return this.fetch('POST', ``, Object.assign({ url }, params));
     }
-    editHook(hookId, url, params = {}) {
+    edit(hookId, url, params = {}) {
         return this.fetch('POST', `/${hookId}`, Object.assign({ url }, params));
     }
-    deleteHook(hookId) {
+    delete(hookId) {
         return this.fetch('DELETE', `/${hookId}`);
@@ -24,0 +34,0 @@ }

package.json

 {
   "name": "gitlab-fetch",
-  "version": "1.0.0",
+  "version": "1.1.0-dev.13830735",
   "author": "Jay Anslow <[e-mail]>",
@@ -5,0 +5,0 @@ "license": "MIT",

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

87271

increased by1.64%

Lines of code

1636

increased by1.24%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes