purescript-bridge: Generate PureScript data types from Haskell data types

[ bsd3, library, web ] [ Propose Tags ] [ Report a vulnerability ]

[Skip to Readme]

Modules

[Index] [Quick Jump]

Language
- PureScript
  - Language.PureScript.Bridge

Downloads

purescript-bridge-0.15.0.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

eskimo, peterbecich

For package maintainers and hackage trustees

edit package information

Candidates

0.3.0.2

Versions [RSS]	0.1.0.0, 0.3.0.0, 0.3.0.2, 0.3.0.3, 0.3.0.4, 0.3.0.5, 0.3.0.6, 0.3.1.0, 0.3.1.1, 0.3.2.0, 0.4.0.0, 0.6.0.0, 0.6.0.1, 0.6.0.2, 0.7.0.0, 0.7.0.1, 0.8.0.0, 0.8.0.1, 0.9.0.0, 0.10.0.0, 0.10.1.0, 0.11.0.0, 0.11.1.0, 0.11.1.1, 0.11.1.2, 0.12.0.0, 0.13.0.0, 0.14.0.0, 0.15.0.0
Dependencies	base (>=4.8 && <6.0), containers, directory, filepath, generic-deriving, lens, mtl, text, transformers [details]
License	BSD-3-Clause
Author	Robert Klotzner
Maintainer	robert . klotzner A T gmx . at
Category	Web
Source repo	head: git clone https://github.com/eskimor/purescript-bridge.git
Uploaded	by peterbecich at 2023-01-28T21:16:28Z
Distributions	LTSHaskell:0.15.0.0, NixOS:0.15.0.0, Stackage:0.15.0.0
Reverse Dependencies	1 direct, 1 indirect [details]
Downloads	21357 total (56 in the last 30 days)
Rating	1.25 (votes: 1) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs available [build log] Last success reported on 2023-01-28 [all 1 reports]

Readme for purescript-bridge-0.15.0.0

[back to package description]

purescript-bridge

Translate your Haskell types to PureScript types. It should in theory work for almost all Haskell types, including type constructors! You just have to instantiate it with dummy parameters from e.g. "Language.PureScript.Bridge.TypeParameters".

Data type translation is fully and easily customizable by providing your own BridgePart instances!

The latest version of this project requires Purescript 0.15.

JSON encoding / decoding

For compatible JSON representations:

On Haskell side:
- Use aeson's generic encoding/decoding with default options
On Purescript side:
- Use purescript-argonaut-aeson-generic >=0.4.1 (GitHub)
- Or use purescript-foreign-generic.
  - This branch is updated for Purescript 0.15.

Documentation

Usage of this library is documented in Language.Purescript.Bridge, with writePSTypes you should have everything to get started. Documentation can be found here.

Status

It works for my use case and is used in production. PRs for more PSTypes definitions and bridges are very welcome!