Can't access private method from within SignalStore

[hafnerpw]

Which @ngrx/* package(s) are the source of the bug?

signals

Minimal reproduction of the bug/regression with instructions

From other methods and hooks inside the signal-store I want to access private methods of it.
The Documentation is not providing an example for it https://ngrx.io/guide/signals/signal-store/private-store-members
So I tried it like this:

export const ComponentMetaInfoStore = signalStore(
  withState<ComponentMetaInfoState>(initialState),
  withMethods(
    (
      store,
      componentsService = inject(ComponentControllerService)
    ) => ({
      _addComponent: (component: ComponentDtoV2) => {
        if (store.components().find((c) => c.id === component.id)) {
          return;
        }
        patchState(store, { components: [...store.components(), component] });
      },
      addComponent: rxMethod<CreateComponentDtoV2>(
        pipe(
          switchMap((component) => componentsService.create({ body: component })),
          tapResponse({
            next: (component) => {
              _addComponent(component);
            },
            error: (error: HttpErrorResponse) => {
              patchState(store, { error: error.message });
            }
          })
        )
      )
    })
  ),
  withHooks((store, eventDispatcher = inject(EventDispatcherService)) => {
    return {
      onInit() {
        eventDispatcher
          .on<ComponentDtoV2>(BaseEventType.CREATE)
          .subscribe((component) => {
            _addComponent(component);
          });
      }
    };
  })
);

other access with this._addComponent or store._addComponent is not possible either.

Expected behavior

private signal store methods should be accessible from within the store. Also the documentation should show an example on how to use it.

Versions of NgRx, Angular, Node, affected browser(s) and operating system(s)

@ngrx/signals: 18.1.0,
@ngrx/operators: 18.1.0,
typescript: 5.4.5,
angular: 18.2.3

Other information

No response

I would be willing to submit a PR to fix this issue

• Yes
• No

[rainerhahnekamp]

Hey, I converted this to a question. You need to put your _addComponent into a variable so that you can reuse it in addCoponent via the scope.

In withHooks, you use store._addComponent.

It would be much faster, if you could provide an example on StackBlitz, but I can already tell you that is not a bug.

[hafnerpw]

Thanks for the quick reply @rainerhahnekamp. I hope I understand it correctly but basically what your saying is that, I can't reference it directly in the withMethods and I should extract it as a variable. Resulting in something like this, right ?

export const ComponentMetaInfoStore = signalStore(
  withState<ComponentMetaInfoState>(initialState),
  withMethods((store, componentsService = inject(ComponentControllerService)) => {
    const _addComponent = (component: ComponentDtoV2) => {
      if (store.components().find((c) => c.id === component.id)) {
        return;
      }
      patchState(store, { components: [...store.components(), component] });
    };
    return {
      _addComponent,
      addComponent: rxMethod<CreateComponentDtoV2>(
        pipe(
          switchMap((component) => componentsService.create({ body: component })),
          tapResponse({
            next: (component) => {
              _addComponent(component);
            },
            error: (error: HttpErrorResponse) => {
              patchState(store, { error: error.message });
            }
          })
        )
      )
    };
  }),
  withHooks((store, eventDispatcher = inject(EventDispatcherService)) => ({
    onInit() {
      eventDispatcher.on<ComponentDtoV2>(BaseEventType.CREATE, 'ComponentDtoV2').subscribe((component) => {
        store._addComponent(component);
      });
    }
  }))
);

It works for me this way, thanks a lot! Hope thats what you have meant, but do you know if there is maybe a more elegant way to write it ?

[rainerhahnekamp]

That's the way how I do it. Alternatively, you could create two withMethods, where the first defines _addComponent, and the second consumes it.

[rainerhahnekamp]

@hafnerpw, if your question has been answered, please mark this issue as answered.