Skip to content

Commit b99db0f

Browse files
Merge pull request #357 from jeroenheijmans/docs/fix-minor-comment-issues
Docs/fix minor comment issues
2 parents 0cac039 + 8fb836d commit b99db0f

File tree

8 files changed

+85
-101
lines changed

8 files changed

+85
-101
lines changed

docs-src/silent-refresh.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ this
7070
.catch(err => console.error('refresh error', err));
7171
```
7272

73-
When there is an error in the iframe that prevents the communication with the main application, silentRefresh will give you a timeout. To configure the timespan for this, you can set the property ``siletRefreshTimeout`` (msec). The default value is 20.000 (20 seconds).
73+
When there is an error in the iframe that prevents the communication with the main application, silentRefresh will give you a timeout. To configure the timespan for this, you can set the property ``silentRefreshTimeout`` (msec). The default value is 20.000 (20 seconds).
7474

7575
### Automatically refreshing a token when/ before it expires
7676

docs/additional-documentation/refreshing-a-token-(silent-refresh).html

+1-1
Original file line numberDiff line numberDiff line change
@@ -655,7 +655,7 @@ <h1 id="refreshing-a-token-when-using-implicit-flow-silent-refresh-">Refreshing
655655
.oauthService
656656
.silentRefresh()
657657
.then(info =&gt; console.debug(&#39;refresh ok&#39;, info))
658-
.catch(err =&gt; console.error(&#39;refresh error&#39;, err));</code></pre><p>When there is an error in the iframe that prevents the communication with the main application, silentRefresh will give you a timeout. To configure the timespan for this, you can set the property <code>siletRefreshTimeout</code> (msec). The default value is 20.000 (20 seconds).</p>
658+
.catch(err =&gt; console.error(&#39;refresh error&#39;, err));</code></pre><p>When there is an error in the iframe that prevents the communication with the main application, silentRefresh will give you a timeout. To configure the timespan for this, you can set the property <code>silentRefreshTimeout</code> (msec). The default value is 20.000 (20 seconds).</p>
659659
<h3 id="automatically-refreshing-a-token-when-before-it-expires">Automatically refreshing a token when/ before it expires</h3>
660660
<p>To automatically refresh a token when/ some time before it expires, just call the following method after configuring the OAuthService:</p>
661661
<pre class="line-numbers"><code class="language-TypeScript">this.oauthService.setupAutomaticSilentRefresh();</code></pre><p>By default, this event is fired after 75% of the token&#39;s life time is over. You can adjust this factor by setting the property <code>timeoutFactor</code> to a value between 0 and 1. For instance, 0.5 means, that the event is fired after half of the life time is over and 0.33 triggers the event after a third.</p>

projects/lib/src/angular-oauth-oidic.module.ts

-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,6 @@ export class OAuthModule {
3333
config: OAuthModuleConfig = null,
3434
validationHandlerClass = NullValidationHandler
3535
): ModuleWithProviders {
36-
// const setupInterceptor = config && config.resourceServer && config.resourceServer.allowedUrls;
37-
3836
return {
3937
ngModule: OAuthModule,
4038
providers: [

projects/lib/src/auth.config.ts

+21-22
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export class AuthConfig {
3737
public oidc? = true;
3838

3939
/**
40-
* Defines whether to request a access token during
40+
* Defines whether to request an access token during
4141
* implicit flow.
4242
*/
4343
public requestAccessToken? = true;
@@ -66,7 +66,6 @@ export class AuthConfig {
6666

6767
/**
6868
* Url of the userinfo endpoint as defined by OpenId Connect.
69-
*
7069
*/
7170
public userinfoEndpoint?: string = null;
7271

@@ -107,9 +106,9 @@ export class AuthConfig {
107106

108107
/**
109108
* Some auth servers don't allow using password flow
110-
* w/o a client secreat while the standards do not
109+
* w/o a client secret while the standards do not
111110
* demand for it. In this case, you can set a password
112-
* here. As this passwort is exposed to the public
111+
* here. As this password is exposed to the public
113112
* it does not bring additional security and is therefore
114113
* as good as using no password.
115114
*/
@@ -159,7 +158,7 @@ export class AuthConfig {
159158
public sessionChecksEnabled? = false;
160159

161160
/**
162-
* Intervall in msec for checking the session
161+
* Interval in msec for checking the session
163162
* according to http://openid.net/specs/openid-connect-session-1_0.html#ChangeNotification
164163
*/
165164
public sessionCheckIntervall? = 3 * 1000;
@@ -183,18 +182,18 @@ export class AuthConfig {
183182
*/
184183
public disableAtHashCheck? = false;
185184

186-
/*
187-
* Defines wether to check the subject of a refreshed token after silent refresh.
188-
* Normally, it should be the same as before.
189-
*/
185+
/**
186+
* Defines wether to check the subject of a refreshed token after silent refresh.
187+
* Normally, it should be the same as before.
188+
*/
190189
public skipSubjectCheck? = false;
191190

192191
public useIdTokenHintForSilentRefresh? = false;
193192

194-
/*
195-
* Defined whether to skip the validation of the issuer in the discovery document.
196-
* Normally, the discovey document's url starts with the url of the issuer.
197-
*/
193+
/**
194+
* Defined whether to skip the validation of the issuer in the discovery document.
195+
* Normally, the discovey document's url starts with the url of the issuer.
196+
*/
198197
public skipIssuerCheck? = false;
199198

200199
/**
@@ -204,17 +203,17 @@ export class AuthConfig {
204203
*/
205204
public fallbackAccessTokenExpirationTimeInSec?: number;
206205

207-
/*
208-
* final state sent to issuer is built as follows:
209-
* state = nonce + nonceStateSeparator + additional state
210-
* Default separator is ';' (encoded %3B).
211-
* In rare cases, this character might be forbidden or inconvenient to use by the issuer so it can be customized.
212-
*/
206+
/**
207+
* final state sent to issuer is built as follows:
208+
* state = nonce + nonceStateSeparator + additional state
209+
* Default separator is ';' (encoded %3B).
210+
* In rare cases, this character might be forbidden or inconvenient to use by the issuer so it can be customized.
211+
*/
213212
public nonceStateSeparator? = ';';
214213

215-
/*
216-
* set this to true to use HTTP BASIC auth for password flow
217-
*/
214+
/**
215+
* Set this to true to use HTTP BASIC auth for password flow
216+
*/
218217
public useHttpBasicAuthForPasswordFlow? = false;
219218

220219
constructor(json?: Partial<AuthConfig>) {

0 commit comments

Comments
 (0)