Skip to content

Commit

Permalink
chore: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
devcui committed Sep 29, 2024
1 parent c59bfff commit 6f9beff
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions packages/auth/docs/send.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ type: Documents

## Authentication style

It is better to add the corresponding authentication information to each request through the HTTP interceptor. `@delonn/auth` implements two separate HTTP interceptors based on two different authentication styles.
It is better to add the corresponding authentication information to each request through the HTTP interceptor. `@yelon/auth` implements two separate HTTP interceptors based on two different authentication styles.

### authSimpleInterceptor

The parameter name and its sending location can be specified via `DelonAuthConfig`, for example:
The parameter name and its sending location can be specified via `YelonAuthConfig`, for example:

```ts
token_send_key = 'token';
Expand Down
4 changes: 2 additions & 2 deletions packages/auth/docs/send.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ type: Documents

## 认证风格

通过HTTP拦截器在每一个请求中加入相应的认证信息,这是再好不过。`@delonn/auth` 根据两种不同认证风格,实现两种各自的HTTP拦截器。
通过HTTP拦截器在每一个请求中加入相应的认证信息,这是再好不过。`@yelon/auth` 根据两种不同认证风格,实现两种各自的HTTP拦截器。

### authSimpleInterceptor

透过 `DelonAuthConfig` 可以指定参数名以及其发送位置,例如:
透过 `YelonAuthConfig` 可以指定参数名以及其发送位置,例如:

```ts
token_send_key = 'token';
Expand Down
8 changes: 4 additions & 4 deletions packages/auth/docs/service.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ After subscribing to `refresh`, the access_token will be automatically triggered

### Property

| Name | Type | Description |
|------|------|-------------|
| `[login_url]` | `string` | Get the login address of `DelonAuthConfig` configuration |
| `[referrer]` | `AuthReferrer` | Get routing before authorization failure |
| Name | Type | Description |
|------|------|----------------------------------------------------------------------------------------------------------------------------------------|
| `[login_url]` | `string` | Get the login address of `YelonAuthConfig` configuration |
| `[referrer]` | `AuthReferrer` | Get routing before authorization failure |
| `[refresh]` | `Observable<ITokenModel>` | Subscription refresh, automatically triggered when expired; **Note** It will be triggered multiple times, please make business process |

### Method
Expand Down
8 changes: 4 additions & 4 deletions packages/auth/docs/service.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ constructor(@Inject(YA_SERVICE_TOKEN) private tokenService: ITokenService) {

### 属性

| 参数名 | 类型 | 描述 |
|-----|----|----|
| `[login_url]` | `string` | 获取 `DelonAuthConfig` 配置的登录地址 |
| `[referrer]` | `AuthReferrer` | 获取授权失败前路由信息 |
| 参数名 | 类型 | 描述 |
|-----|----|--------------------------------------------------------|
| `[login_url]` | `string` | 获取 `YelonAuthConfig` 配置的登录地址 |
| `[referrer]` | `AuthReferrer` | 获取授权失败前路由信息 |
| `[refresh]` | `Observable<ITokenModel>` | 订阅刷新,订阅时会自动产生一个定时器,每隔一段时间进行一些校验;**注意** 会多次触发,请务必做好业务判断 |

### 方法
Expand Down
4 changes: 2 additions & 2 deletions packages/auth/src/social/social.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import { Observable, Observer } from 'rxjs';

import { YA_SERVICE_TOKEN, ITokenModel } from '../token/interface';

const OPENTYPE = '_delonAuthSocialType';
const HREFCALLBACK = '_delonAuthSocialCallbackByHref';
const OPENTYPE = '_yelonAuthSocialType';
const HREFCALLBACK = '_yelonAuthSocialCallbackByHref';

export type SocialOpenType = 'href' | 'window';

Expand Down

0 comments on commit 6f9beff

Please sign in to comment.