Skip to content
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![npm](https://img.shields.io/npm/v/%40ngrx-toolkit%2Fcore.svg)](https://www.npmjs.com/package/%40ngrx-toolkit%2Fcore)

<a href="https://ngrx-toolkit.github.io/ngrx-toolkit/"><img src="https://raw.githubusercontent.com/ngrx-toolkit/ngrx-toolkit/main/logo.png" width="320" style="text-align: center" /></a>
<a href="https://ngrx-toolkit.github.io/ngrx-toolkit/"><img src="https://raw.githubusercontent.com/ngrx-toolkit/core/main/logo.png" width="320" style="text-align: center" /></a>

NgRx Toolkit is a set of extensions to the NgRx Signals Store, like

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/mutations.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This guide covers
- State signals available (`value/status/error/isPending`)
<!-- TODO - resolve when #235 closed-->
- For `httpMutation`, the response type is specified with the param `parse: (res: T) => res as T`
- `hasValue` signal to narrow type. ⚠️NOTE⚠️: currently there is an [outstanding bug](https://github.com/ngrx-toolkit/ngrx-toolkit/issues/235) that this does not properly narrow.
- `hasValue` signal to narrow type. ⚠️NOTE⚠️: currently there is an [outstanding bug](https://github.com/ngrx-toolkit/core/issues/235) that this does not properly narrow.
- [How to use](#usage-withmutations-or-solo-functions), as:
- _standalone functions_
- In `withMutations` store _feature_
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/team.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ import Team from '@site/src/components/Team';

## Contribute

We welcome contributions from the community! If you're interested in contributing to NgRx Toolkit, check out our [GitHub repository](https://github.com/ngrx-toolkit/ngrx-toolkit) and our [contribution guidelines](https://github.com/ngrx-toolkit/ngrx-toolkit/blob/main/CONTRIBUTING.md).
We welcome contributions from the community! If you're interested in contributing to NgRx Toolkit, check out our [GitHub repository](https://github.com/ngrx-toolkit/core) and our [contribution guidelines](https://github.com/ngrx-toolkit/core/blob/main/CONTRIBUTING.md).
2 changes: 1 addition & 1 deletion docs/docs/with-devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export const FlightStore = signalStore(

After that, open your app and navigate to the component that uses the store. Open the Devtools and you will see the `flights` store in the Devtools under the name "NgRx Signal Store"

You can find a working example in the [demo app](https://github.com/ngrx-toolkit/ngrx-toolkit/blob/main/apps/demo/src/app/devtools/todo-store.ts).
You can find a working example in the [demo app](https://github.com/ngrx-toolkit/core/blob/main/apps/demo/src/app/devtools/todo-store.ts).

:::info
The extensions don't activate during app initialization (as it is with `@ngrx/store`). You need to open the Devtools and select the "NgRx Signal Store" tab to activate them.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/with-feature-factory.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ Use `import { withFeature } from '@ngrx/signals'` instead.
- NgRx PR: ["feat(signals): add `withFeature` #4739"](https://github.com/ngrx/platform/pull/4739)
- NgRx [documentation section](https://ngrx.io/guide/signals/signal-store/custom-store-features#connecting-a-custom-feature-with-the-store) on `withFeature`

In the future, `withFeatureFactory` will likely be removed, provided a right migration path is prepared. Watch out for PRs, and see [the PR that deprecates `withFeatureFactory` for the initial plan for handling the removal](https://github.com/ngrx-toolkit/ngrx-toolkit/pull/167#pullrequestreview-2735443379).
In the future, `withFeatureFactory` will likely be removed, provided a right migration path is prepared. Watch out for PRs, and see [the PR that deprecates `withFeatureFactory` for the initial plan for handling the removal](https://github.com/ngrx-toolkit/core/pull/167#pullrequestreview-2735443379).
:::
2 changes: 1 addition & 1 deletion docs/docs/with-resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Options:
1. `'previous value'`. The resource's previous value will be returned.
1. `'native'`. No special handling is provided, inline with default error behavior.

Under the hood, `'previous value'` and `'undefined value'` proxy the value. For a detailed explanation for why this is done, check out the [JSDoc for the error handling strategy](https://github.com/ngrx-toolkit/ngrx-toolkit/blob/main/libs/ngrx-toolkit/src/lib/with-resource.ts#L402).
Under the hood, `'previous value'` and `'undefined value'` proxy the value. For a detailed explanation for why this is done, check out the [JSDoc for the error handling strategy](https://github.com/ngrx-toolkit/core/blob/main/libs/ngrx-toolkit/src/lib/with-resource.ts#L402).

The implications of `undefined value` is that the inferred value can be `undefined`, even if there is a `defaultValue` set for the resource.
For example, in the [`Updating`](#updating) section, `listValue` will be inferred as `User[] | undefined`. To be able to infer the type with a guaranteed value,
Expand Down
5 changes: 2 additions & 3 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,7 @@ const config: Config = {
sidebarPath: './sidebars.ts',
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/ngrx-toolkit/ngrx-toolkit/tree/main/docs/',
editUrl: 'https://github.com/ngrx-toolkit/core/tree/main/docs/',
},
blog: false,
theme: {
Expand Down Expand Up @@ -101,7 +100,7 @@ const config: Config = {
label: 'Community',
},
{
href: 'https://github.com/ngrx-toolkit/ngrx-toolkit',
href: 'https://github.com/ngrx-toolkit/core',
label: 'GitHub',
position: 'right',
},
Expand Down
2 changes: 1 addition & 1 deletion libs/ngrx-toolkit/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# NgRx Toolkit

<img src="https://raw.githubusercontent.com/ngrx-toolkit/ngrx-toolkit/main/logo.png" width="320" />
<img src="https://raw.githubusercontent.com/ngrx-toolkit/core/main/logo.png" width="320" />

NgRx Toolkit is a set of extensions to the NgRx Signals Store, like

Expand Down
2 changes: 1 addition & 1 deletion libs/ngrx-toolkit/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"license": "MIT",
"repository": {
"type": "GitHub",
"url": "https://github.com/ngrx-toolkit/ngrx-toolkit"
"url": "https://github.com/ngrx-toolkit/core"
},
"publishConfig": {
"access": "public"
Expand Down
2 changes: 1 addition & 1 deletion libs/ngrx-toolkit/src/lib/devtools/with-devtools.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {
import { DevtoolsSyncer } from './internal/devtools-syncer.service';
import { ReduxDevtoolsExtension } from './internal/models';

// Users requested that we export this type: https://github.com/ngrx-toolkit/ngrx-toolkit/issues/178
// Users requested that we export this type: https://github.com/ngrx-toolkit/core/issues/178
export type DevtoolsFeature = DevtoolsFeatureInternal;

declare global {
Expand Down
4 changes: 2 additions & 2 deletions libs/ngrx-toolkit/src/lib/with-mutations.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@ describe('withMutations with rxMutation', () => {
});

it('does not expose mutation properties directly, only the method', async () => {
// Test case for https://github.com/ngrx-toolkit/ngrx-toolkit/issues/286
// Test case for https://github.com/ngrx-toolkit/core/issues/286
const testSetup = createTestSetup(switchOp);
const store = testSetup.store;

Expand All @@ -548,7 +548,7 @@ describe('withMutations with rxMutation', () => {
});

it('types mutation method as plain callable Promise signature and returns nothing else from a mutation', () => {
// Test case for https://github.com/ngrx-toolkit/ngrx-toolkit/issues/286
// Test case for https://github.com/ngrx-toolkit/core/issues/286
const testSetup = createTestSetup();
const store = testSetup.store;

Expand Down
Loading