drizzle-team / drizzle-team/drizzle-orm

[DOCS]: Add basic documentation for common types, preferably via jsdoc.

Open
#4,729 1 comment 0 reactions 0 assignees View on GitHub
docs
Dominant language
TypeScript
Stars
35.8k
Forks
1.6k
Avg merge
2d 7h
Merged PRs (30d)
4

Description

### Enhancement hasn't been filed before.

- [x] I have verified this enhancement I'm about to request hasn't been suggested before.

### Describe the enhancement you want to request

Drizzle is missing the most basic documentation that is needed right at the beginning of a developers journey with Drizzle.

```ts
const db = drizzle({ logger, schema, casing, cache }); // What's the default for casing?
```

I couldn't find an answer on the documentation site, so I had to search the code starting [here](https://github.com/drizzle-team/drizzle-orm/blob/ac1dcd9d1c4b8f171479af4a5dd731db1e164f58/drizzle-orm/src/utils.ts#L219-L224) and finding the answer (I think) [here](https://github.com/drizzle-team/drizzle-orm/blob/ac1dcd9d1c4b8f171479af4a5dd731db1e164f58/drizzle-orm/src/casing.ts#L38-L42).

However, preferably I would never have to open the documentation site for such a commonly needed bit of information.

I would be glad to produce a pull request that adds some light details to the most commonly used types such as `DrizzleConfig`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.