Skip to content

Commit b454c1f

Browse files
committed
Synced repo with latest changes from TS SDK
1 parent b9c8ee1 commit b454c1f

173 files changed

Lines changed: 27867 additions & 1242 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.eslintrc.json

Lines changed: 0 additions & 158 deletions
This file was deleted.

DECISIONS.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Decisions
2+
---
3+
4+
This document serves to record design decisions to try and share historical context as the project evolves.
5+
6+
## 5/*/2022
7+
8+
### Using CJS modules instead of ESM modules
9+
10+
who: @nicktomlin
11+
12+
Moving to ESM would mean potentially breaking compatability with folks on modern versions of node who have not switched to ESM and additional overhead in maintaining both systems. Some library authors have decided to simply [convert to ESM wholesale](https://blog.sindresorhus.com/get-ready-for-esm-aa53530b3f77).
13+
14+
I would suggest we maintain CJS compat for now, in the hope that there's either better tooling for "dual publishing" or enough momentum behind ESM that publishing a breaking ESM-only version does not cause too much churn for users.
15+
16+
Because it's relatively simple to support interop between ESM and CJS, and the wide footprint.
17+
18+
19+
### Using `node-fetch`
20+
21+
who: @nicktomlin
22+
23+
I initially explored [`undici`](https://github.com/nodejs/undici) as a way of using the built-in `fetch` support in node.
24+
25+
Unfortunately, at the time of writing there's no clean way to handle `tls` options. Additionally, `fetch` is experimental for node 16.x which results in warnings.
26+
27+
At some point in the future, it would be nice to migrate over once undici's `fetch` implementation is a little more feature rich and things have stabalized.
28+
29+
30+
### Using `jest` for testing
31+
32+
`jest` can be a little magical, but it's relatively fast (with 28.x especially), ergonomic, and provides a simple maintenance story over a BYO setup.
33+
34+
I considered `mocha` and `ava` (which i've also used and like) but `jest` struck the best balance between simplicity and feature-set at the moment.
35+
36+
### Using `tsup` to publish
37+
38+
who: @nicktomlin
39+
40+
Typescript publication can be a wacky process and `tsup` simplifies a lot of this.

Dockerfile

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)