Skip to content

Commit 546b651

Browse files
committed
docs: update README.md
1 parent 35ff0f5 commit 546b651

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,14 +186,22 @@ This will poll in a regular interval and only resolve with tokens once the end-u
186186

187187
```ts
188188
let scope!: string // Scope of the access request
189-
let login_hint!: string // one of login_hint, id_token_hint, or login_hint_token parameters must be provided in CIBA
189+
/**
190+
* One of login_hint, id_token_hint, or login_hint_token parameters must be
191+
* provided in CIBA
192+
*/
193+
let login_hint!: string
190194

191195
let response = await client.initiateBackchannelAuthentication(config, {
192196
scope,
193197
login_hint,
194198
})
195199

196-
// OPTIONAL: If your client is configured with Ping Mode you'd invoke the following after getting the CIBA Ping Callback (its implementation is framework specific and therefore out of scope for openid-client)
200+
/**
201+
* OPTIONAL: If your client is configured with Ping Mode you'd invoke the
202+
* following after getting the CIBA Ping Callback (its implementation is
203+
* framework specific and therefore out of scope for openid-client)
204+
*/
197205

198206
let tokens: client.TokenEndpointResponse =
199207
await client.pollBackchannelAuthenticationGrant(config, response)

0 commit comments

Comments
 (0)