Skip to content

doc: Storage factory explanation on withStorageSync() #141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/docs/with-storage-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,39 @@ public class SyncedStoreComponent {
}
}
```
## Injecting services
The `storage` property requires a factory function that returns a `Storage` implementation. If you have a custom `Storage` implementation that is `Injectable`, you can provide it as a factory parameters using the `inject` function.

Example:

```typescript
@Injectable({providedIn: 'root'})
export class MyStorage implements Storage {
[name: string]: any;
length: number;
clear(): void {
...
}
getItem(key: string): string | null {
...
}
key(index: number): string | null {
...
}
removeItem(key: string): void {
...
}
setItem(key: string, value: string): void {
...
}

}
```

```typescript
const SyncStore = signalStore(
withStorageSync<User>({
storage: (myStorageImplementation = inject(MyStorage)) => myStorageImplementation,
})
);
```
Loading