Fix TS definition for appSessionSecret #52
Conversation
| @@ -23,7 +23,7 @@ interface ConfigParams { | |||
| * REQUIRED. The secret(s) used to derive an encryption key for the user identity in a session cookie. | |||
| * Can use env key APP_SESSION_SECRET instead. | |||
| */ | |||
| appSessionSecret: boolean | string | string[]; | |||
| appSessionSecret?: boolean | string | string[]; | |||
There was a problem hiding this comment.
Are there any tests needed around this?
There was a problem hiding this comment.
I don't know but probably not? Are there test you can write for a JS library TS definition file?
There was a problem hiding this comment.
Not so much the definition file but I meant the fact that the property is now optional. What happens when it's not supplied and and environment variable isn't set?
There was a problem hiding this comment.
Then you'll get a validation error on startup.
| @@ -23,7 +23,7 @@ interface ConfigParams { | |||
| * REQUIRED. The secret(s) used to derive an encryption key for the user identity in a session cookie. | |||
There was a problem hiding this comment.
Should this now read OPTIONAL?
There was a problem hiding this comment.
No, it's still required but you can set the value in your env and not in the config object.
There was a problem hiding this comment.
Hmm, feels weird to have an optional property here but then say it's required in the docs. Wouldn't that confuse people?
There was a problem hiding this comment.
The application needs a value, that part is a requirement, but you can set it in the config object (which the TS defs affect) or you can set it in an env variable and skip the config key. Either way it is used by the app.
There was a problem hiding this comment.
Description
Fix TS definition for
appSessionSecretconfig key, should be optional as it can be defined in an env var.References
Related to #46