Skip to content

Commit 65988ad

Browse files
HolfHolf
authored
Merge pull request #30 from drtrt-org/beta
Release to main
2 parents e84f0dc + 6fbb328 commit 65988ad

16 files changed

+6906
-8532
lines changed

‎.eslintignore

-1
This file was deleted.

‎.eslintrc.cjs

-50
This file was deleted.

‎.vscode/settings.json

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2+
"eslint.useFlatConfig": true,
23
"cSpell.words": ["writable"]
34
}

‎CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## [1.2.0-beta.1](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/compare/v1.1.1...v1.2.0-beta.1) (2024-08-26)
2+
3+
### Features
4+
5+
* update all dependencies to latest major version ([d3cd6e4](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/commit/d3cd6e497378dbbef382b93e251e6ae325959181))
6+
17
## [1.1.1](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/compare/v1.1.0...v1.1.1) (2024-08-25)
28

39

‎docs/.nojekyll

-1
This file was deleted.

‎docs/README.md

+7-112
Original file line numberDiff line numberDiff line change
@@ -1,124 +1,19 @@
1-
@drtrt/give-svelte-store-previous-behaviour
1+
**@drtrt/give-svelte-store-previous-behaviour** • **Docs**
22

3-
# @drtrt/give-svelte-store-previous-behaviour
3+
***
44

5-
## Table of contents
5+
# @drtrt/give-svelte-store-previous-behaviour
66

7-
### Interfaces
7+
## Interfaces
88

99
- [ReadableWithPrevious](interfaces/ReadableWithPrevious.md)
1010
- [WritableWithPrevious](interfaces/WritableWithPrevious.md)
1111

12-
### Type Aliases
13-
14-
- [SubscriberWithPrevious](README.md#subscriberwithprevious)
15-
16-
### Functions
17-
18-
- [getPrevious](README.md#getprevious)
19-
- [giveSvelteStorePreviousBehaviour](README.md#givesveltestorepreviousbehaviour)
20-
2112
## Type Aliases
2213

23-
### SubscriberWithPrevious
24-
25-
Ƭ **SubscriberWithPrevious**\<`T`\>: (`value`: `T`, `previousValue`: `T` \| `undefined`) => `void`
26-
27-
#### Type parameters
28-
29-
| Name |
30-
| :------ |
31-
| `T` |
32-
33-
#### Type declaration
34-
35-
▸ (`value`, `previousValue`): `void`
36-
37-
##### Parameters
38-
39-
| Name | Type |
40-
| :------ | :------ |
41-
| `value` | `T` |
42-
| `previousValue` | `T` \| `undefined` |
43-
44-
##### Returns
45-
46-
`void`
47-
48-
#### Defined in
49-
50-
[src/SubscriberWithPrevious.ts:1](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/blob/9a03dcb/src/SubscriberWithPrevious.ts#L1)
14+
- [SubscriberWithPrevious](type-aliases/SubscriberWithPrevious.md)
5115

5216
## Functions
5317

54-
### getPrevious
55-
56-
▸ **getPrevious**\<`T`\>(`store`): `undefined` \| `T`
57-
58-
#### Type parameters
59-
60-
| Name |
61-
| :------ |
62-
| `T` |
63-
64-
#### Parameters
65-
66-
| Name | Type |
67-
| :------ | :------ |
68-
| `store` | [`ReadableWithPrevious`](interfaces/ReadableWithPrevious.md)\<`T`\> |
69-
70-
#### Returns
71-
72-
`undefined` \| `T`
73-
74-
#### Defined in
75-
76-
[src/getPrevious.ts:3](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/blob/9a03dcb/src/getPrevious.ts#L3)
77-
78-
___
79-
80-
### giveSvelteStorePreviousBehaviour
81-
82-
▸ **giveSvelteStorePreviousBehaviour**\<`T`\>(`store`): [`WritableWithPrevious`](interfaces/WritableWithPrevious.md)\<`T`\>
83-
84-
#### Type parameters
85-
86-
| Name |
87-
| :------ |
88-
| `T` |
89-
90-
#### Parameters
91-
92-
| Name | Type |
93-
| :------ | :------ |
94-
| `store` | `Writable`\<`T`\> |
95-
96-
#### Returns
97-
98-
[`WritableWithPrevious`](interfaces/WritableWithPrevious.md)\<`T`\>
99-
100-
#### Defined in
101-
102-
[src/giveSvelteStorePreviousBehaviour.ts:7](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/blob/9a03dcb/src/giveSvelteStorePreviousBehaviour.ts#L7)
103-
104-
▸ **giveSvelteStorePreviousBehaviour**\<`T`\>(`store`): [`ReadableWithPrevious`](interfaces/ReadableWithPrevious.md)\<`T`\>
105-
106-
#### Type parameters
107-
108-
| Name |
109-
| :------ |
110-
| `T` |
111-
112-
#### Parameters
113-
114-
| Name | Type |
115-
| :------ | :------ |
116-
| `store` | `Readable`\<`T`\> |
117-
118-
#### Returns
119-
120-
[`ReadableWithPrevious`](interfaces/ReadableWithPrevious.md)\<`T`\>
121-
122-
#### Defined in
123-
124-
[src/giveSvelteStorePreviousBehaviour.ts:8](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/blob/9a03dcb/src/giveSvelteStorePreviousBehaviour.ts#L8)
18+
- [getPrevious](functions/getPrevious.md)
19+
- [giveSvelteStorePreviousBehaviour](functions/giveSvelteStorePreviousBehaviour.md)

‎docs/functions/getPrevious.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
[**@drtrt/give-svelte-store-previous-behaviour**](../README.md) • **Docs**
2+
3+
***
4+
5+
[@drtrt/give-svelte-store-previous-behaviour](../README.md) / getPrevious
6+
7+
# Function: getPrevious()
8+
9+
> **getPrevious**\<`T`\>(`store`): `undefined` \| `T`
10+
11+
## Type Parameters
12+
13+
• **T**
14+
15+
## Parameters
16+
17+
• **store**: [`ReadableWithPrevious`](../interfaces/ReadableWithPrevious.md)\<`T`\>
18+
19+
## Returns
20+
21+
`undefined` \| `T`
22+
23+
## Defined in
24+
25+
[src/getPrevious.ts:3](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/blob/ce8fffa2f41148829af1b11f1805e1bfeae3ded0/src/getPrevious.ts#L3)

‎docs/functions/giveSvelteStorePreviousBehaviour.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
[**@drtrt/give-svelte-store-previous-behaviour**](../README.md) • **Docs**
2+
3+
***
4+
5+
[@drtrt/give-svelte-store-previous-behaviour](../README.md) / giveSvelteStorePreviousBehaviour
6+
7+
# Function: giveSvelteStorePreviousBehaviour()
8+
9+
## giveSvelteStorePreviousBehaviour(store)
10+
11+
> **giveSvelteStorePreviousBehaviour**\<`T`\>(`store`): [`WritableWithPrevious`](../interfaces/WritableWithPrevious.md)\<`T`\>
12+
13+
### Type Parameters
14+
15+
• **T**
16+
17+
### Parameters
18+
19+
• **store**: `Writable`\<`T`\>
20+
21+
### Returns
22+
23+
[`WritableWithPrevious`](../interfaces/WritableWithPrevious.md)\<`T`\>
24+
25+
### Defined in
26+
27+
[src/giveSvelteStorePreviousBehaviour.ts:7](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/blob/ce8fffa2f41148829af1b11f1805e1bfeae3ded0/src/giveSvelteStorePreviousBehaviour.ts#L7)
28+
29+
## giveSvelteStorePreviousBehaviour(store)
30+
31+
> **giveSvelteStorePreviousBehaviour**\<`T`\>(`store`): [`ReadableWithPrevious`](../interfaces/ReadableWithPrevious.md)\<`T`\>
32+
33+
### Type Parameters
34+
35+
• **T**
36+
37+
### Parameters
38+
39+
• **store**: `Readable`\<`T`\>
40+
41+
### Returns
42+
43+
[`ReadableWithPrevious`](../interfaces/ReadableWithPrevious.md)\<`T`\>
44+
45+
### Defined in
46+
47+
[src/giveSvelteStorePreviousBehaviour.ts:8](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/blob/ce8fffa2f41148829af1b11f1805e1bfeae3ded0/src/giveSvelteStorePreviousBehaviour.ts#L8)

‎docs/interfaces/ReadableWithPrevious.md

+27-30
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,61 @@
1-
[@drtrt/give-svelte-store-previous-behaviour](../README.md) / ReadableWithPrevious
1+
[**@drtrt/give-svelte-store-previous-behaviour**](../README.md) • **Docs**
22

3-
# Interface: ReadableWithPrevious\<T\>
3+
***
44

5-
## Type parameters
5+
[@drtrt/give-svelte-store-previous-behaviour](../README.md) / ReadableWithPrevious
66

7-
| Name |
8-
| :------ |
9-
| `T` |
7+
# Interface: ReadableWithPrevious\<T\>
108

11-
## Hierarchy
9+
## Extends
1210

1311
- `Readable`\<`T`\>
1412

15-
↳ **`ReadableWithPrevious`**
13+
## Extended by
1614

17-
↳↳ [`WritableWithPrevious`](WritableWithPrevious.md)
15+
- [`WritableWithPrevious`](WritableWithPrevious.md)
1816

19-
## Table of contents
17+
## Type Parameters
2018

21-
### Properties
22-
23-
- [previousValueStore](ReadableWithPrevious.md#previousvaluestore)
24-
- [subscribe](ReadableWithPrevious.md#subscribe)
19+
• **T**
2520

2621
## Properties
2722

2823
### previousValueStore
2924

30-
• **previousValueStore**: `Readable`\<`undefined` \| `T`\>
25+
> **previousValueStore**: `Readable`\<`undefined` \| `T`\>
3126
3227
#### Defined in
3328

34-
[src/ReadableWithPrevious.ts:11](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/blob/9a03dcb/src/ReadableWithPrevious.ts#L11)
29+
[src/ReadableWithPrevious.ts:11](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/blob/ce8fffa2f41148829af1b11f1805e1bfeae3ded0/src/ReadableWithPrevious.ts#L11)
30+
31+
***
32+
33+
### subscribe()
34+
35+
> **subscribe**: (`this`, `run`, `invalidate`?) => `Unsubscriber`
3536
36-
___
37+
Subscribe on value changes.
3738

38-
### subscribe
39+
#### Parameters
3940

40-
• **subscribe**: (`this`: `void`, `run`: [`SubscriberWithPrevious`](../README.md#subscriberwithprevious)\<`T`\>, `invalidate?`: `Invalidator`\<`T`\>) => `Unsubscriber`
41+
• **this**: `void`
4142

42-
#### Type declaration
43+
• **run**: [`SubscriberWithPrevious`](../type-aliases/SubscriberWithPrevious.md)\<`T`\>
4344

44-
▸ (`this`, `run`, `invalidate?`): `Unsubscriber`
45+
subscription callback
4546

46-
##### Parameters
47+
• **invalidate?**: `Invalidator`\<`T`\>
4748

48-
| Name | Type |
49-
| :------ | :------ |
50-
| `this` | `void` |
51-
| `run` | [`SubscriberWithPrevious`](../README.md#subscriberwithprevious)\<`T`\> |
52-
| `invalidate?` | `Invalidator`\<`T`\> |
49+
cleanup callback
5350

54-
##### Returns
51+
#### Returns
5552

5653
`Unsubscriber`
5754

5855
#### Overrides
5956

60-
Readable.subscribe
57+
`Readable.subscribe`
6158

6259
#### Defined in
6360

64-
[src/ReadableWithPrevious.ts:6](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/blob/9a03dcb/src/ReadableWithPrevious.ts#L6)
61+
[src/ReadableWithPrevious.ts:6](https://github.com/drtrt-org/give-svelte-store-previous-behaviour/blob/ce8fffa2f41148829af1b11f1805e1bfeae3ded0/src/ReadableWithPrevious.ts#L6)

0 commit comments

Comments
 (0)