It's all-typescript now

Author: YChebotaev

.github/workflows/release.yaml

@@ -11,6 +11,7 @@ jobs:
         with:
           node-version: 16
       - run: npm test
+      - run: npm build
       - uses: JS-DevTools/npm-publish@v1
         with:
           token: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,3 +1,4 @@
+# General
 .DS_Store
 .AppleDouble
 .LSOverride
@@ -16,6 +17,7 @@ Icon
 .TemporaryItems
 .Trashes
 .VolumeIcon.icns
+.com.apple.timemachine.donotpresent
 
 # Directories potentially created on remote AFP share
 .AppleDB
@@ -27,28 +29,130 @@ Temporary Items
 # Logs
 logs
 *.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
 # Runtime data
 pids
 *.pid
 *.seed
+*.pid.lock
 
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
 
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 
+# Bower dependency directory (https://bower.io/)
+bower_components
+
 # node-waf configuration
 .lock-wscript
 
-# Compiled binary addons (http://nodejs.org/api/addons.html)
+# Compiled binary addons (https://nodejs.org/api/addons.html)
 build/Release
 
-# Dependency directory
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
 
-node_modules
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

README.md

@@ -1,62 +1,42 @@
-json-decycle (es6)
-============
+# json-decycle
 
 Stringify and parse cycled reference json by replacing cycled references to [JSON-reference](https://json-spec.readthedocs.io/reference.html)
 
-Is project alive?
-----------------
+## Is project alive?
 
 Yes, it works just fine.
 
 Because this library have no dependencies, it's not required to have frequent updates.
 
 If You encounter a bug or need to support special case, feel free to file an issue or open PR.
 
-Usage
------
+## Usage
 
-```javascript
-var decycle = require('json-decycle').decycle
-var retrocycle = require('json-decycle').retrocycle
+```tsx
+import { decycle, retrocycle } from "json-decycle";
 
 var cycled = {
   foo: {},
-  bar: {}
-}
+  bar: {},
+};
 
-cycled.foo.bar = cycled.foo
-cycled.bar.foo = cycled.bar
+cycled.foo.bar = cycled.foo;
+cycled.bar.foo = cycled.bar;
 
-var result = JSON.stringify(cycled, decycle())
+var result = JSON.stringify(cycled, decycle());
 // result === '{"foo":{"bar":{"foo":{"$ref":"#/foo"}}},"bar":{"$ref":"#/foo/bar"}}'
 
-JSON.parse(result, retrocycle())
+JSON.parse(result, retrocycle());
 // => {foo: {{foo: [cyclic reference], bar: [cyclic reference]}}, bar: {{foo: [cyclic reference], bar: [cyclic reference]}}}
-
 ```
 
-Extend JSON global object
--------------------------
+## Extend JSON global object
 
 `JSON.parse` and `JSON.stringify` is not modified
 
-```javascript
-require('json-decycle').extend(JSON)
-
-JSON.decycle({}) === '{}'
-JSON.retrocycle('{}') === {}
-```
-
-ES6 features
-------------
-
-Library depends on es6 features `Map`, `WeakMap`, `WeakSet` and `Set` so if you environment does not support this features, you can override it:
-
-```javascript
-const jsonDecycle = require('json-decycle')
+```tsx
+import { extend } from "json-decycle";
 
-jsonDecycle.Map = Map
-jsonDecycle.WeakMap = WeakMap
-jsonDecycle.WeakSet = WeakSet
-jsonDecycle.Set = Set
+JSON.decycle({}) === "{}";
+JSON.retrocycle("{}") === {};
 ```