Skip to content

Commit dca0502

Browse files
committed
updating specs
1 parent 78d1f5b commit dca0502

3 files changed

Lines changed: 13 additions & 8 deletions

File tree

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# API Reference
22

33
- [Data](./api/data/Nest.md)
4-
`Nest`, readonly wrappers, map/set helpers, parsers, and cookies.
4+
`Nest`, readonly wrappers, map and set helpers, parsers, and cookie helpers.
55
- [Events](./api/events/EventEmitter.md)
66
`EventEmitter`, `ExpressEmitter`, and `RouteEmitter`.
77
- [Queues](./api/queue/ItemQueue.md)
@@ -21,7 +21,7 @@
2121
- [Map](./api/data/Map.md)
2222
- [Set](./api/data/Set.md)
2323
- [Parsers](./api/data/Parsers.md)
24-
- [cookie](./api/data/Cookie.md)
24+
- [Cookie](./api/data/Cookie.md)
2525

2626
## Events
2727

docs/api/router/Session.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,17 @@ Cookie-oriented session storage for requests and responses.
66

77
```ts
88
import type { CallableSession } from '@stackpress/lib';
9-
import { session } from '@stackpress/lib/Session';
10-
import { ReadSession, WriteSession } from '@stackpress/lib/Session';
9+
import { ReadSession, WriteSession, session } from '@stackpress/lib/Session';
1110
```
1211

13-
`ReadSession`, `WriteSession`, and `session()` are package-exported by the `@stackpress/lib/Session` subpath. They are not re-exported from the root barrel.
12+
Import `ReadSession`, `WriteSession`, and `session()` from the
13+
`@stackpress/lib/Session` subpath. The root barrel only re-exports the
14+
`CallableSession` type.
1415

1516
## When To Use It
1617

17-
Use these APIs when you need one session abstraction for request reads and response-side cookie revisions.
18+
Use these APIs when you need one session abstraction for request reads and
19+
response-side cookie revisions.
1820

1921
## API
2022

@@ -66,7 +68,8 @@ store('sessionId');
6668
store.get('sessionId');
6769
```
6870

69-
`session(data?)` returns a `CallableSession` with these additional exposed properties:
71+
`session(data?)` returns a `CallableSession` with the usual callable lookup plus
72+
these exposed properties:
7073

7174
- `data`
7275
- `options`

docs/api/types/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ import type {
3434
} from '@stackpress/lib/types';
3535
```
3636

37-
`@stackpress/lib/types` is the intended import path for the type surface. Many types are re-exported from the root barrel, but the dedicated types subpath is the clearest stable reference point.
37+
Use `@stackpress/lib/types` when you want a dedicated import path for the public
38+
type surface. Many of these types are also re-exported from the root barrel, but
39+
the `types` subpath is the clearest stable reference point.
3840

3941
## Data Types
4042

0 commit comments

Comments
 (0)