firebase / firebase/firebase-functions

Limit the exposed API to necessary methods and types

Open
#451 5 comments 1 reaction 0 assignees View on GitHub
cleanup tracked internally
Dominant language
TypeScript
Stars
1.1k
Forks
232
Avg merge
20h 46m
Merged PRs (30d)
15

Description

Since we're working on a v3 release, it might be wise to revise the API of the library. Multiple types are exposed that seem not necessary, which might result in issues when internal structure of the library is modified (e.g. `LegacyEvent`).

It's also easier for developers when autocomplete suggests only usable types and it's not bloated with internals.

We should verify that all exported types actually belong to the API layer. This can be done by modifying the following:

https://github.com/firebase/firebase-functions/blob/18c01cbdc25d8f4fccb8847f6a4be86b6c7d4960/src/index.ts#L55-L57

in the following way:

```ts
export { Only, Necessary, Types } from './config';
export { No, Internals } from './cloud-functions';
export { Nice, And, Small } from './function-builder';
```

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.