Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: readCache takes an object too #226

Closed
wants to merge 1 commit into from
+2 −2
Closed

docs: readCache takes an object too #226

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/pages/postgraphile/usage-library.md
View file
Original file line number Diff line number Diff line change
@@ -162,7 +162,7 @@ The `postgraphile` middleware factory function takes three arguments, all of whi
- `prependPlugins`: An array of [Graphile Engine](/graphile-build/plugins/) schema plugins to load before the default plugins (you probably don't want this).
- `replaceAllPlugins`: The full array of [Graphile Engine](/graphile-build/plugins/) schema plugins to use for schema generation (you almost definitely don't want this!).
- `skipPlugins`: An array of [Graphile Engine](/graphile-build/plugins/) schema plugins to skip.
- `readCache`: A file path string. Reads cached values from local cache file to improve startup time (you may want to do this in production).
- `readCache`: A file path string or an object. Reads cached values to improve startup time (you may want to do this in production).
- `writeCache`: A file path string. Writes computed values to local cache file so startup can be faster (do this during the build phase).
- `exportJsonSchemaPath`: Enables saving the detected schema, in JSON format, to the given location. The directories must exist already, if the file exists it will be overwritten.
- `exportGqlSchemaPath`: Enables saving the detected schema, in GraphQL schema format, to the given location. The directories must exist already, if the file exists it will be overwritten.
2 changes: 1 addition & 1 deletion src/pages/postgraphile/usage-schema.md
View file
Original file line number Diff line number Diff line change
@@ -97,7 +97,7 @@ The returned GraphQLSchema will **not** be updated when your database changes -
- `prependPlugins`: An array of [Graphile Engine](/graphile-build/plugins/) schema plugins to load before the default plugins (you probably don't want this).
- `replaceAllPlugins`: The full array of [Graphile Engine](/graphile-build/plugins/) schema plugins to use for schema generation (you almost definitely don't want this!).
- `skipPlugins`: An array of [Graphile Engine](/graphile-build/plugins/) schema plugins to skip.
- `readCache`: A file path string. Reads cached values from local cache file to improve startup time (you may want to do this in production).
- `readCache`: A file path string or an object. Reads cached values to improve startup time (you may want to do this in production).
- `writeCache`: A file path string. Writes computed values to local cache file so startup can be faster (do this during the build phase).
- `jwtSecret`: The secret for your JSON web tokens. This will be used to verify tokens in the `Authorization` header, and signing JWT tokens you return in procedures.
- `jwtPgTypeIdentifier`: The Postgres type identifier for the compound type which will be signed as a JWT token if ever found as the return type of a procedure. Can be of the form: `my_schema.my_type`. You may use quotes as needed: `"my-special-schema".my_type`.