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 5, 2024
1 parent 41576e0 commit 05c57bd
Show file tree
Hide file tree
Showing 4 changed files with 124 additions and 23 deletions.
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@ 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.0](https://github.com/masa-finance/masa-express/compare/v1.5.0...v2.0.0)

> 5 April 2024
- feature: optimize config [`273f664`](https://github.com/masa-finance/masa-express/commit/273f6645b572eb601a611228965424eea92db11e)

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

> 5 April 2024
- feature: added a flag to make logging less verbose [`eaddb5d`](https://github.com/masa-finance/masa-express/commit/eaddb5d181c263aa0f044fa54ae1818856ae5a54)

#### [v1.4.5](https://github.com/masa-finance/masa-express/compare/v1.4.4...v1.4.5)

> 26 March 2024
#### [v1.4.4](https://github.com/masa-finance/masa-express/compare/v1.4.3...v1.4.4)

> 25 March 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
- v1.4.4](../README.md) / [Exports](../modules.md) / CustomSessionFields
- v2.0.0](../README.md) / [Exports](../modules.md) / CustomSessionFields

# Interface: CustomSessionFields

Expand Down
79 changes: 79 additions & 0 deletions docs/interfaces/MasaSessionArgs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
[# Masa Express
- v2.0.0](../README.md) / [Exports](../modules.md) / MasaSessionArgs

# Interface: MasaSessionArgs

## Table of contents

### Properties

- [domain](MasaSessionArgs.md#domain)
- [environment](MasaSessionArgs.md#environment)
- [sameSite](MasaSessionArgs.md#samesite)
- [secret](MasaSessionArgs.md#secret)
- [secure](MasaSessionArgs.md#secure)
- [sessionName](MasaSessionArgs.md#sessionname)
- [sessionNamespace](MasaSessionArgs.md#sessionnamespace)
- [store](MasaSessionArgs.md#store)
- [ttl](MasaSessionArgs.md#ttl)
- [verbose](MasaSessionArgs.md#verbose)

## Properties

### domain

**domain**: `string`

___

### environment

**environment**: `string`

___

### sameSite

`Optional` **sameSite**: ``"none"`` \| ``"lax"`` \| ``"strict"``

___

### secret

**secret**: `string`

___

### secure

`Optional` **secure**: `boolean`

___

### sessionName

**sessionName**: `string`

___

### sessionNamespace

**sessionNamespace**: `string`

___

### store

`Optional` **store**: `Store`

___

### ttl

**ttl**: `number`

___

### verbose

`Optional` **verbose**: `boolean`
50 changes: 28 additions & 22 deletions docs/modules.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
[# Masa Express
- v1.4.4](README.md) / Exports
- v2.0.0](README.md) / Exports

# # Masa Express
- v1.4.4
- v2.0.0

## Table of contents

### Interfaces

- [CustomSessionFields](interfaces/CustomSessionFields.md)
- [MasaSessionArgs](interfaces/MasaSessionArgs.md)

### Functions

Expand All @@ -24,18 +25,9 @@

#### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `«destructured»` | `Object` | `undefined` |
| › `domain` | `string` | `".masa.finance"` |
| › `environment` | `string` | `undefined` |
| › `sameSite?` | ``"none"`` \| ``"lax"`` \| ``"strict"`` | `undefined` |
| › `secret` | `string` | `undefined` |
| › `secure?` | `boolean` | `undefined` |
| › `sessionName` | `string` | `undefined` |
| › `store?` | `Store` | `undefined` |
| › `ttl` | `number` | `undefined` |
| › `verbose?` | `boolean` | `false` |
| Name | Type |
| :------ | :------ |
| `«destructured»` | [`MasaSessionArgs`](interfaces/MasaSessionArgs.md) |

#### Returns

Expand All @@ -45,35 +37,49 @@ ___

### MasaSessionRouter

**MasaSessionRouter**(`«destructured»`): `Router`
**MasaSessionRouter**(`args`): `Object`

#### Parameters

| Name | Type |
| :------ | :------ |
| `«destructured»` | `Object` |
| › `sessionMiddleware` | `RequestHandler`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\> |
| › `sessionName` | `string` |
| › `sessionNamespace` | `string` |
| `args` | [`MasaSessionArgs`](interfaces/MasaSessionArgs.md) |

#### Returns

`Router`
`Object`

| Name | Type |
| :------ | :------ |
| `middleware` | `RequestHandler`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\> |
| `router` | `Router` |

___

### sessionCheckHandler

**sessionCheckHandler**(`request`, `response`, `next`): `undefined` \| `Response`\<`ISession` \| `BaseResult`, `Record`\<`string`, `any`\>\>
**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
##### Returns

`undefined` \| `Response`\<`ISession` \| `BaseResult`, `Record`\<`string`, `any`\>\>

0 comments on commit 05c57bd

Please sign in to comment.