https://github.com/csbiology/dynamicobj

F# library supporting Dynamic Objects including inheritance in functional style
https://github.com/csbiology/dynamicobj

Last synced: 1 day ago
JSON representation

F# library supporting Dynamic Objects including inheritance in functional style

• Host: GitHub
• URL: https://github.com/csbiology/dynamicobj
• Owner: CSBiology
• License: mit
• Created: 2021-01-27T18:43:10.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-20T14:26:16.000Z (14 days ago)
• Last Synced: 2025-01-02T09:12:27.721Z (1 day ago)
• Language: F#
• Homepage: https://csbiology.github.io/DynamicObj/
• Size: 558 KB
• Stars: 16
• Watchers: 3
• Forks: 4
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DynamicObj

F# library supporting Dynamic Objects including inheritance in functional style.

The library is compatible with [Fable](https://github.com/fable-compiler/Fable), allowing transpilation to `javascript` and `python`.

The primary use case of DynamicObj is the **extension of F# classes with dynamic properties**.

This is useful when you want to add arbitrarily typed properties to a class **at runtime**.

> Why would you want to do that?

Yes, The type system is one of the core strengths of F#, and it is awesome.

However, there are cases where a static domain model is either unfeasible or not flexible enough, especially when interfacing with dynamic languages such as JavaScript or Python.

DynamicObj is transpilable into JS and Python via [Fable](https://github.com/fable-compiler/Fable), meaning you can use it to create classes that are usable in both .NET and those languages, while making their usage (e.g., the setting of dynamic properties) both safe in .NET and idiomatic in JS/Python.

## Docs

Documentation is hosted at https://csbiology.github.io/DynamicObj/

## Development

#### Requirements

- [nodejs and npm](https://nodejs.org/en/download)

    - verify with `node --version` (Tested with v18.16.1)

    - verify with `npm --version` (Tested with v9.2.0)

- [.NET SDK](https://dotnet.microsoft.com/en-us/download)

    - verify with `dotnet --version` (Tested with 7.0.306)

- [Python](https://www.python.org/downloads/)

    - verify with `py --version` (Tested with 3.12.2, known to work only for >=3.11)

#### Local Setup

On windows you can use the `setup.cmd` to run the following steps automatically!

1. Setup dotnet tools

   `dotnet tool restore`

2. Install NPM dependencies

   

    `npm install`

3. Setup python environment

    

    `py -m venv .venv`

Verify correct setup with `./build.cmd runtests` ✨