Skip to content

Commit 38ad76b

Browse files
docs: clarify FileInstallationStore and FileStateStore are dev-only (#2446)
Co-authored-by: Luke Russell <[email protected]>
1 parent 9a0c4c4 commit 38ad76b

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/english/oauth.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,10 @@ app.get('/slack/oauth_redirect', (req, res) => {
250250

251251
Although this package uses a default `MemoryInstallationStore`, it isn't recommended for production purposes since the access tokens it stores are lost when the process terminates or restarts. To override this default, `InstallProvider` allows for supplying your own `installationStore`, which is then used to save and retrieve installation information (like tokens) to your own database.
252252

253-
For more persistent storage during development, `FileInstallationStore` is a provided alternative to `MemoryInstallationStore` and is available for import and use directly from the package. Customizable options for this store include specifying the `baseDir`, `clientId`, and `historicalDataEnabled`.
253+
For more persistent storage during development, `FileInstallationStore` is a provided alternative to `MemoryInstallationStore` and is available for import and use directly from the package. Customizable options for this store include specifying the `baseDir`, `clientId`, and `historicalDataEnabled`.
254+
255+
:::warning[`FileInstallationStore` and `FileStateStore` are for development only and you should supply your own `installationStore` for production deployments.]
256+
:::
254257

255258
An installation store is an object that provides three methods: `storeInstallation`, `fetchInstallation`, and `deleteInstallation`. `storeInstallation` takes an `installation` as an argument, which is an object that contains all installation related data (like tokens, teamIds, enterpriseIds, etc). `fetchInstallation` and `deleteInstallation` both take in an `installQuery`, which is used to query the database. The `installQuery` can contain `teamId`, `enterpriseId`, `userId`, `conversationId` and `isEnterpriseInstall`.
256259

@@ -473,4 +476,4 @@ const installer = new InstallProvider({
473476

474477
This package supports Node v14 and higher. It's highly recommended to use [the latest LTS version of
475478
node](https://github.com/nodejs/Release#release-schedule), and the documentation is written using syntax and features
476-
from that version.
479+
from that version.

0 commit comments

Comments
 (0)