lscontests 1.5.0 → 1.5.1

package/README.md

@@ -8,10 +8,14 @@
 ![npm](https://img.shields.io/npm/v/lscontests)
 ![npm](https://img.shields.io/npm/dw/lscontests)
 
-A CLI tool to get information about the contests on each OJ
+A tool to get information about the contests on each OJ.
 
 ## Usage
 
+### CLI
+
+You can use cli to get a list of contests information easily.
+
 ```bash
 lsct [options]
 
@@ -23,6 +27,78 @@ Options:
   -h, --help         display help for command
 ```
 
+Its performance:
+
+```bash
+> lsct
+[
+  {
+    ojName: 'Codeforces',
+    name: 'Codeforces Round #790 (Div. 4)',
+    rule: 'ICPC',
+    startTime: 2022-05-10T14:35:00.000Z,
+    endTime: 2022-05-10T16:35:00.000Z,
+    url: 'https://codeforces.com/contests/1676'
+  },
+  {
+    ojName: 'NowCoder',
+    name: '牛客挑战赛60',
+    rule: 'ICPC',
+    startTime: 2022-05-13T11:00:00.000Z,
+    endTime: 2022-05-13T14:00:00.000Z,
+    url: 'https://ac.nowcoder.com/acm/contest/11200'
+  }
+]
+```
+
+### API
+
+If you want to call lscontests in your project to get a list of contests information, or if you need to add OJ support, then you can call the lscontests API like the following:
+
+#### Get a list of contests information
+
+```typescript
+import { list } from "lscontests";
+
+list().then(console.log);
+```
+
+The result of this code is the same as using cli directly without arguments.
+
+#### Add OJ support
+
+```typescript
+import { addOJ, list } from "lscontests";
+
+addOJ("ts", {
+    name: "testOJ", get: async () => [{
+        ojName: "testOJ",
+        name: "testContest",
+        rule: "ICPC",
+        startTime: new Date(Date.now() + 5 * 86400000),
+        endTime: new Date(Date.now() + 6 * 86400000),
+        url: "https://www.test.com"
+    }]
+});
+
+list(["ts"], 7).then(console.log);
+```
+
+The result of this code is as follows:
+
+```bash
+[
+  {
+    ojName: 'testOJ',
+    name: 'testContest',
+    rule: 'ICPC',
+    startTime: 2022-05-15T11:50:42.032Z,
+    endTime: 2022-05-16T11:50:42.032Z,
+    url: 'https://www.test.com'
+  }
+]
+```
+
 ## License
 
 [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.html)

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 import { addOJ } from "./lib/oj";
-declare function list(abbrList: string[], days: number): Promise<import("./lib/contest").contest[]>;
+declare function list(abbrList?: string[], days?: number): Promise<import("./lib/contest").contest[]>;
 export { addOJ, list };

package/dist/index.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.list = exports.addOJ = void 0;
 const oj_1 = require("./lib/oj");
 Object.defineProperty(exports, "addOJ", { enumerable: true, get: function () { return oj_1.addOJ; } });
-function list(abbrList, days) {
+function list(abbrList, days = 3) {
     return __awaiter(this, void 0, void 0, function* () {
         if (!abbrList)
             abbrList = Object.keys(oj_1.alloj);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iCAAwC;AAa/B,sFAbA,UAAK,OAaA;AAXd,SAAe,IAAI,CAAC,QAAkB,EAAE,IAAY;;QAChD,IAAI,CAAC,QAAQ;YAAE,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,UAAK,CAAC,CAAC;QAC7C,OAAO,CAAC,MAAM,OAAO,CAAC,GAAG,CACrB,QAAQ,CAAC,GAAG,CACR,CAAO,IAAI,EAAE,EAAE;YAAC,OAAA,CAAC,MAAM,UAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAC5C,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAI,IAAe,GAAG,QAAQ,CAAC,CAC7E,CAAA;UAAA,CACJ,CACJ,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7C,CAAC;CAAA;AAEe,oBAAI"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iCAAwC;AAa/B,sFAbA,UAAK,OAaA;AAXd,SAAe,IAAI,CAAC,QAAmB,EAAE,IAAI,GAAG,CAAC;;QAC7C,IAAI,CAAC,QAAQ;YAAE,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,UAAK,CAAC,CAAC;QAC7C,OAAO,CAAC,MAAM,OAAO,CAAC,GAAG,CACrB,QAAQ,CAAC,GAAG,CACR,CAAO,IAAI,EAAE,EAAE;YAAC,OAAA,CAAC,MAAM,UAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAC5C,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAI,IAAe,GAAG,QAAQ,CAAC,CAC7E,CAAA;UAAA,CACJ,CACJ,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7C,CAAC;CAAA;AAEe,oBAAI"}

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "lscontests",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "A tool to get information about the contests on each OJ",
   "keywords": [
+    "cli",
+    "OJ",
+    "Codeforces",
     "competitive-programming"
   ],
   "repository": "https://github.com/StableAgOH/lscontests",