Added comments

This commit is contained in:
斟酌 鵬兄 2023-01-17 02:46:17 +08:00
parent 93b5a804df
commit b2d27d2ca0

View File

@ -32,6 +32,26 @@ class SignInEventArgs
class Signin extends EventEmitter
{
/** Conf structure
* {
* "spec": process.env.OPENID_SPEC_URI
* , "authorization_endpoint_params": {
* "client_id": process.env.AZURE_AD_CLIENT_ID
* , "redirect_url": `https://${HOST_NAME}/user/login/`
* , "nonce": "{RANDSTR}"
* , "state": "{RANDSTR}"
* , "scope": "openid profile email"
* , "response_mode": "form_post"
* , "response_type": "id_token"
* }
* , "end_session_endpoint_params": {
* "post_logout_redirect_uri": `https://${HOST_NAME}/user/logout/`
* }
*
* NOTE:
* set Signin().RANDSTR = () => SecureRandStr(); to enable custom templated functions
* * Only support "^{FUNCTION_NAME}$" for now
**/
constructor( conf )
{
super();