vkontakte-api - npm Package Compare versions

Comparing version 1.3.8 to 1.3.9

CHANGELOG.md

@@ -5,2 +5,10 @@ # Changelog
 
+### [1.3.9](https://github.com/wolframdeus/vk-api/compare/v1.3.8...v1.3.9) (2020-06-16)
+
+
+### Bug Fixes
+
+* **types:** requestConfig.method is string ([d72ec49](https://github.com/wolframdeus/vk-api/commit/d72ec49dbf9d07a9119f742e95b5dedb754dee4c))
+* **vkapimaster:** make init public ([3f30b22](https://github.com/wolframdeus/vk-api/commit/3f30b22702fb8d5389db317ae77c7cf260519707))
+
 ### [1.3.8](https://github.com/wolframdeus/vk-api/compare/v1.3.7...v1.3.8) (2020-06-15)
@@ -7,0 +15,0 @@

dist/multithreading/VKAPIMaster/VKAPIMaster.d.ts

@@ -18,3 +18,3 @@ import { VKAPIMasterConstructorProps } from './types';
      */
-    private init;
+    init(): void;
 }

dist/types/shared.d.ts

@@ -45,11 +45,11 @@ /**
  */
-export interface RequestConfig<M extends string = string, P extends {} = any> {
+export interface RequestConfig<P extends {} = any> {
     /**
      * API method name
      */
-    method: M;
+    method: string;
     /**
      * List of params for passed method
      */
-    params: P;
+    params: P & RequestOptionalParams;
 }
@@ -59,3 +59,3 @@ /**
  */
-export declare type SendRequest = <M extends string = string, P extends {} = any, R = any>(config: RequestConfig<M, P>) => Promise<R>;
+export declare type SendRequest = <P extends {} = any, R = any>(config: RequestConfig<P>) => Promise<R>;
 /**
@@ -62,0 +62,0 @@ * Describes repository method

package.json

 {
   "name": "vkontakte-api",
-  "version": "1.3.8",
+  "version": "1.3.9",
   "main": "dist/index.js",
@@ -5,0 +5,0 @@ "types": "dist/index.d.ts",

README.md

@@ -1,3 +0,196 @@
-# vk-api
+[npm-badge]: https://img.shields.io/npm/v/vkontakte-api.svg
+[npm-link]: https://npmjs.com/package/vkontakte-api
 
-To be done in near future
+[<img src="https://i.imgur.com/uOIQBBR.png">](https://vk.com/dev)
+# vkontakte-api [![NPM][npm-badge]][npm-link]
+
+TypeScript library to make requests performing to VK API simple
+
+## Installation
+```bash
+yarn add vkontakte-api
+```
+or
+```bash
+npm i vkontakte-api
+```
+
+## Description
+
+`vkontakte-api` follows repositories based concept where each repository is a 
+class and represents some namespace in API. The main purpose of repository
+is to format request config for VKAPI instance, so he could perform request
+and return data.
+
+Each request is added to queue and executed only after timeout, calculated
+according to `rps` property, is elapsed. So, there is no case when you were 
+banned due to sending too many requests per second.
+
+There is a multi-thread (multi-workers) support for those projects which are
+launched in this mode.  
+
+## Usage
+
+### Creating instance
+First, it is required to create `VKAPI` instance:
+```typescript
+import {VKAPI} from 'vkontakte-api';
+
+const api = new VKAPI();
+``` 
+
+It is allowed to pass `rps` property which means `requests per second`. VK
+API has its restriction, so make sure you have passed correct value. 
+
+Additionally, you can pass properties `accessToken` and `lang` which will be 
+used as default parameters for each request. So, you have no need to pass them
+each time until overriding is needed. 
+
+Here is how it looks like:
+```typescript
+const api = new VKAPI({
+  rps: 20,
+  accessToken: 'my default token',
+  lang: 'uk',
+});
+```
+
+### Performing requests
+
+VKAPI instance contains a list of repositories which generate request parameters
+to send to API. Each repository is named according to its name in 
+[API](https://vk.com/dev/methods).
+
+Simple example of sending request and logging data:
+```typescript
+import {VKAPI} from 'vkontakte-api';
+
+const api = new VKAPI();
+
+api.users.get({userIds: ['vladkibenko']}).then(console.log);
+```
+
+Sending some notification:
+```typescript
+api.notifications.sendMessage({
+  userIds: ['vladkibenko'],
+  message: 'Hello Vlad!',
+});
+```
+
+Overriding default `lang` and `accessToken`:
+```typescript
+import {LangEnum, VKAPI} from 'vkontakte-api';
+
+const api = new VKAPI({accessToken: 'my personal user token'});
+
+// Here we will get english-localized data from some application's face
+api.users.get({
+  userIds: ['vladkibenko'],
+  accessToken: 'some application token',
+  // Or you could just use 'uk' or 1
+  lang: LangEnum.UK,
+}).then(console.log);
+```
+
+Some of methods are not currently typed or realised. So, you are free to perform
+custom requests. **Make sure, all of `Params` and `Response` fields are camel 
+cased, because internally, `vkontakte-api` moves them from snake to camel 
+case for easier usage**:
+
+```typescript
+import {VKAPI} from 'vkontakte-api';
+
+const api = new VKAPI({accessToken: 'my token'});
+
+// Description of parameters
+interface Params {
+  cityIds: string;
+}
+
+// Description of response
+type Response = Array<{
+  id: number;
+  title: string;
+}>;
+
+// @see https://vk.com/dev/database.getCitiesById
+api.addRequestToQueue<Params, Response>({
+  method: 'database.getCitiesById',
+  params: {
+    cityIds: [1].join(','),
+  },
+}).then(console.log);
+```
+
+### Errors
+
+Sometimes, API throws errors. To detect if error was thrown by VK, you could
+use function `isVKError` which detects if error is `VKError`. It contains
+property `data` which contains all error data (it is typed, by the way).
+
+Moreover, lib contains enum `ErrorsEnum` which is a set of all known errors.
+
+### Multi-threading support
+
+In case your project is ran in multi cluster mode, you could use `VKAPIMaster`
+and `VKAPISlave`.
+
+`VKAPIMaster` should be used in main thread. To create its instance, it is 
+required to pass `VKAPI` instance which will perform all of the requests and
+list of workers, containing `VKAPISlave` which should communicate with 
+`VKAPIMaster`.
+
+With this scheme we are getting single `VKAPI` instance for project and
+not overflowing API restriction connected with requests per second. 
+
+You can find more complex example [here](https://github.com/wolframdeus/backend-template/blob/master/src/index.ts).
+
+Here is example:
+```typescript
+import {fork, isMaster, Worker} from 'cluster';
+import os from 'os';
+import {VKAPI, VKAPIMaster, VKAPISlave, VKAPIInterface} from 'vkontakte-api';
+
+// Runs http server. Accepts an object which looks like VKAPI instance. So,
+// he does not know what api exactly is. It could be real VKAPI instance or
+// VKAPISlave, we dont care, it is the same in this context
+function http(api: VKAPIInterface) {
+  // Here we can use all of the VKAPI methods due to they are defined
+  // interface. We does not really care what api is
+  api.users.get({userIds: ['vladkibenko']}).then(console.log);
+}
+
+// Just a stub. You can use the logic you need
+const isDev = process.env.NODE_ENVIRONMENT === 'development';
+
+// In development mode, let us run single thread. So, no VKAPIMaster and
+// VKAPISlave are needed
+if (isDev) {
+  const api = new VKAPI();
+  
+  // Run http server
+  return http(api);
+}
+
+// In production mode, we do create as many forks as processor support
+if (isMaster) {
+  const cpuCount = os.cpus().length;
+  const workers: Worker[] = [];
+
+  for (let i = 0; i < cpuCount; i++) {
+    workers.push(fork());
+  }
+
+  // In master we do create VKAPI instance, because slaves should
+  // communicate with single its instance, which is in VKAPIMaster
+  const master = new VKAPIMaster({workers, instance: new VKAPI()});
+  master.init();
+} 
+// In slave workers, we just create http server with VKAPISlave
+else {
+  // Slave has no its own settings due to it is just a class, which communicates
+  // with master. So, all settings are set in VKAPIMaster 
+  http(new VKAPISlave());
+}
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

61964

increased by10.98%

Number of lines in readme file

197

increased by4825%

No dependency changes