@types/rison - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

rison/index.d.ts

 // Type definitions for Rison
 // Project: https://github.com/Nanonid/rison
 // Definitions by: Andrei Kurosh <https://github.com/impworks>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 export = rison;
@@ -6,0 +6,0 @@ export as namespace rison;

rison/LICENSE

     MIT License
 
-    Copyright (c) Microsoft Corporation. All rights reserved.
+    Copyright (c) Microsoft Corporation.
 
@@ -5,0 +5,0 @@ Permission is hereby granted, free of charge, to any person obtaining a copy

rison/package.json

 {
     "name": "@types/rison",
-    "version": "0.0.6",
+    "version": "0.0.7",
     "description": "TypeScript definitions for Rison",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rison",
     "license": "MIT",
@@ -9,15 +10,17 @@ "contributors": [
             "name": "Andrei Kurosh",
-            "url": "https://github.com/impworks"
+            "url": "https://github.com/impworks",
+            "githubUsername": "impworks"
         }
     ],
     "main": "",
+    "types": "index.d.ts",
     "repository": {
         "type": "git",
-        "url": "https://www.github.com/DefinitelyTyped/DefinitelyTyped.git"
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/rison"
     },
     "scripts": {},
     "dependencies": {},
-    "peerDependencies": {},
-    "typesPublisherContentHash": "e9dd9e7dc0afe140432adc1a63fca9c3c0c156614eedade4130f79e393a7f07c",
-    "typeScriptVersion": "2.0"
+    "typesPublisherContentHash": "fb53901c2059e36544095d21e6e712413d1fa1e4a7f803f56898ba1ae0ca5083",
+    "typeScriptVersion": "3.6"
 }

rison/README.md

@@ -8,10 +8,72 @@ # Installation
 # Details
-Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rison
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rison.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rison/index.d.ts)
+````ts
+// Type definitions for Rison
+// Project: https://github.com/Nanonid/rison
+// Definitions by: Andrei Kurosh <https://github.com/impworks>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+export = rison;
+export as namespace rison;
+declare var rison: IRison;
 
-Additional Details
- * Last updated: Fri, 23 Jun 2017 17:37:55 GMT
+interface IRison {
+    /**
+     * Rison-encodes a javascript structure.
+     * @param obj Object to encode.
+     * @returns {} Encoded string.
+     */
+    encode(obj: any): string;
+
+    /**
+     * Rison-encodes a javascript object without surrounding parens (O-Rison).
+     * @param obj Object to encode.
+     * @returns {} Encoded string.
+     */
+    encode_object<T>(obj: T): string;
+
+    /**
+     * Rison-encodes a javascript array without surrounding parens (A-Rison).
+     * @param obj Object to encode.
+     * @returns {} Encoded string.
+     */
+    encode_array<T>(arr: T[]): string;
+
+    /**
+     * Rison-encodes and then url-escapes a javascript structure.
+     * @param obj Object to encode.
+     * @returns {} Encoded string.
+     */
+    encode_uri(obj: any): string;
+
+    /**
+     * Parses a Rison string into a javascript structure.
+     * @param encoded Encoded string.
+     * @returns {} Resulting array or object.
+     */
+    decode<T>(encoded: string): T;
+
+    /**
+     * Parses a O-Rison string into a javascript object.
+     * @param encoded Encoded string.
+     * @returns {} Resulting object.
+     */
+    decode_object<T>(encoded: string): T;
+
+    /**
+     * Parses a A-Rison string into a javascript array.
+     * @param encoded Encoded string.
+     * @returns {} Resulting array.
+     */
+    decode_array<T>(encoded: string): T[];
+}
+
+````
+
+### Additional Details
+ * Last updated: Fri, 09 Jul 2021 02:32:42 GMT
  * Dependencies: none
- * Global values: rison
+ * Global values: `rison`
 
 # Credits
-These definitions were written by Andrei Kurosh <https://github.com/impworks>.
+These definitions were written by [Andrei Kurosh](https://github.com/impworks).

Fixed alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5789

49.09%

Number of low quality alerts

1

-50%

Number of lines in readme file

79

364.71%

No dependency changes