Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-dixon committed Oct 12, 2024
1 parent d923550 commit ae42b65
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,22 @@ const hello = ell.simple(

const result = await hello({ firstName: 'John', lastName: 'Doe' })
```


## Runtime and module support
Ell TypeScript aims to support all JavaScript backend runtimes in addition to commonjs and ES modules.

At the time of writing Node.js has full support for versinoning and tracing.

Runtime variable capture depends on the `node:inspector` library or an equivalent. Vercel Edge runtime does not yet support this.

## Developing

Tests are currently written with two test frameworks, vitest and mocha.

Vitest does not have accurate source maps, allowing us to simulate cases where a program's source maps are not available.
There are a different set of expectations in this case, namely that the program does not blow up, but that lmps are not tracked or versioned.
These tests end in `.test.ts`.

Mocha tests use ts-node which we have found to have accurate source maps and is used for all tests that depend on them existing and being accurate.
These tests end in `.mocha.ts`.

0 comments on commit ae42b65

Please sign in to comment.