Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
H34D committed Apr 12, 2024
1 parent cc6b9bd commit d368486
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 35 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file. Dates are d

Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).

#### [v2.0.1](https://github.com/masa-finance/masa-express/compare/v2.0.0...v2.0.1)

> 5 April 2024
- fix: session gates [`efb5811`](https://github.com/masa-finance/masa-express/commit/efb58113a8e794221648c00c930c24e6a4040695)

### [v2.0.0](https://github.com/masa-finance/masa-express/compare/v1.5.0...v2.0.0)

> 5 April 2024
Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/CustomSessionFields.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[# Masa Express
- v2.0.0](../README.md) / [Exports](../modules.md) / CustomSessionFields
- v2.0.1](../README.md) / [Exports](../modules.md) / CustomSessionFields

# Interface: CustomSessionFields

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/MasaSessionArgs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[# Masa Express
- v2.0.0](../README.md) / [Exports](../modules.md) / MasaSessionArgs
- v2.0.1](../README.md) / [Exports](../modules.md) / MasaSessionArgs

# Interface: MasaSessionArgs

Expand Down
36 changes: 3 additions & 33 deletions docs/modules.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[# Masa Express
- v2.0.0](README.md) / Exports
- v2.0.1](README.md) / Exports

# # Masa Express
- v2.0.0
- v2.0.1

## Table of contents

Expand All @@ -15,7 +15,6 @@

- [MasaSessionMiddleware](modules.md#masasessionmiddleware)
- [MasaSessionRouter](modules.md#masasessionrouter)
- [sessionCheckHandler](modules.md#sessioncheckhandler)

## Functions

Expand Down Expand Up @@ -53,33 +52,4 @@ ___
| :------ | :------ |
| `middleware` | `RequestHandler`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\> |
| `router` | `Router` |

___

### sessionCheckHandler

**sessionCheckHandler**(`verbose?`): (`request`: `RequestSession`, `response`: `Response`\<`ISession` \| `BaseResult`, `Record`\<`string`, `any`\>\>, `next`: `NextFunction`) => `undefined` \| `Response`\<`ISession` \| `BaseResult`, `Record`\<`string`, `any`\>\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `verbose?` | `boolean` |

#### Returns

`fn`

▸ (`request`, `response`, `next`): `undefined` \| `Response`\<`ISession` \| `BaseResult`, `Record`\<`string`, `any`\>\>

##### Parameters

| Name | Type |
| :------ | :------ |
| `request` | `RequestSession` |
| `response` | `Response`\<`ISession` \| `BaseResult`, `Record`\<`string`, `any`\>\> |
| `next` | `NextFunction` |

##### Returns

`undefined` \| `Response`\<`ISession` \| `BaseResult`, `Record`\<`string`, `any`\>\>
| `sessionChecker` | `RequestHandler`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\> |

0 comments on commit d368486

Please sign in to comment.