Skip to content

typedefs/typedefs.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status

JS version of Typedefs

Generated from ParserJS.idr.

  • Published on npm as typedefs-js, to install for Node run,
    npm install -s typedefs-js
    
  • It is also available for the browser using the unpkg CDN, use the following magic HTML incantation.
    <script type="text/javascript" src="https://unpkg.com/typedefs-js"></script>

Usage example

For node

let {generateType, generateTermSerializers} = require('typedefs-js')

let haskellCode = generateTermSerializers('haskell', '(name Bit (+ 1 1))')
console.log(haskellCode)

In the browser

<script type="text/javascript" src="https://unpkg.com/typedefs-js"></script>

<script type="text/javascript">
let haskell = Typedefs. generateTermSerializers('haskell', '(name Bit (+ 1 1))')
console.log(haskell)
</script>

API

generateType : String -> String -> Either String String

Generate the type definitions in the target language the given typedef as a string.

The first argument to this function is the backend name as a string:

  • haskell
  • reasonml
  • json (only supports closed typedefs)

The second argument is the typedef string.

Errors are returned as a string on the Left value of the either as is customary.

generateTermSerializers : String -> String -> Either String String

Generate code in the target language that serialize and deserialize the given typedef as a string.

The first argument to this function is the backend name as a string:

  • haskell
  • reasonml
  • json (only supports closed typedefs)

The second argument is the typedef string.

Errors are returned as a string on the Left value of the either as is customary.

Publishing an update to npm

Be sure to bump the version in package.json. Then also run npm i to rebuild and update the package-lock.json, then commit and push and CI should publish the build to npm.

About

Typedefs library as a JavaScript NPM module

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy