Skip to content

Commit

Permalink
docs: Update type of accessToken from function to property
Browse files Browse the repository at this point in the history
  • Loading branch information
trandaison committed Oct 3, 2024
1 parent 073dc6e commit 471f92b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 15 deletions.
14 changes: 7 additions & 7 deletions docs/api/$auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,48 +138,48 @@ By default, this instance has the following features:
- Automatically refresh the access token if it has expired (when the request returns a 401 status code), then retry the request.
- Debug log if the [debug option](/api/options.html#debug) is set to `true`.

## Methods

### `accessToken`

```ts
function accessToken(): string | null | undefined;
accessToken: string | null;
```

Contains the value of the access token, returns `null` if not logged in or the token has expired.

### `refreshToken`

```ts
function refreshToken(): string | null | undefined;
refreshToken: string | null;
```

Contains the value of the refresh token, returns `null` if not logged in or the token has expired.

### `hasTokens`

```ts
function hasTokens(): boolean;
hasTokens: boolean;
```

Has a value of `true` when there are tokens in the cookie and the tokens are still valid (either access token or refresh token).

### `isSessionExpired`

```ts
function isSessionExpired(): boolean;
isSessionExpired: boolean;
```

Has a value of `true` when the user is **logged in but the access token has expired** while **the refresh token is still valid**.

### `isSessionEnd`

```ts
function isSessionEnd(): boolean;
isSessionEnd: boolean;
```

Has a value of `true` when both the access token and refresh token have expired.

## Methods

### `login`

```ts
Expand Down
15 changes: 7 additions & 8 deletions docs/vi/api/$auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,49 +137,48 @@ Instance này mặc định được thiết lập sẵn một số cài đặt
- Tự động refresh token khi request trả về lỗi `401 Unauthorized`, sau đó retry lại request.
- Debug log nếu set [option debug](/vi/api/options.html#debug)`true`.

## Methods


### `accessToken`

```ts
function accessToken(): string | null | undefined;
accessToken: string | null;
```

Chứa giá trị của access token, trả về `null` nếu chưa đăng nhập hoặc token đã hết hạn.

### `refreshToken`

```ts
function refreshToken(): string | null | undefined;
refreshToken: string | null;
```

Chứa giá trị của refesh token, trả về `null` nếu chưa đăng nhập hoặc token đã hết hạn.

### `hasTokens`

```ts
function hasTokens(): boolean;
hasTokens: boolean;
```

Có giá trị `true` khi có token trong cookie và token còn hạn sử dụng (bất kể access token hoặc refresh token).

### `isSessionExpired`

```ts
function isSessionExpired(): boolean;
isSessionExpired: boolean;
```

Có giá trị `true` khi user đã log in nhưng **access token đã hết hạn** nhưng **refresh token vẫn còn hạn sử dụng**.

### `isSessionEnd`

```ts
function isSessionEnd(): boolean;
isSessionEnd: boolean;
```

Có giá trị `true` khi cả access token và refresh token đều đã hết hạn.

## Methods

### `login`

```ts
Expand Down

0 comments on commit 471f92b

Please sign in to comment.