API Reference

DateProxyFactoryclass

Creates date proxies that map setter calls to semantic date-part change events.

Overview

Date proxy factory that maps setter calls to semantic date-part changes.

Quick facts

Kind: class
Module: proxies/date-proxy
Base class: GroupedKeyedInstanceFactory< number, IDateProxyData, IDateObserverProxyPair, IDateProxyIdData >
Implements: IDateProxyFactory
Members: 5
Package: @rs-x/core
Source: proxies/date-proxy/date-proxy.factory.ts

Import

import { DateProxyFactory } from '@rs-x/state-manager';

Example

import { InjectionContainer } from '@rs-x/core';
import {
  RsXStateManagerInjectionTokens,
  RsXStateManagerModule,
  type IDateProxyFactory,
} from '@rs-x/state-manager';

await InjectionContainer.load(RsXStateManagerModule);

// Resolve from DI container (do not construct this service directly).
const dateProxy = InjectionContainer.get<IDateProxyFactory>(
  RsXStateManagerInjectionTokens.IDateProxyFactory,
);
console.log(dateProxy);

Constructor injection example

import { Inject } from '@rs-x/core';
import {
  RsXStateManagerInjectionTokens,
  type IDateProxyFactory,
} from '@rs-x/state-manager';

class MyConsumer {
  constructor(
    @Inject(RsXStateManagerInjectionTokens.IDateProxyFactory)
    private readonly dependency: IDateProxyFactory,
  ) {}
}

Members

5 members in this class.

constructor

constructorpublic

constructor( @Inject(RsXCoreInjectionTokens.IProxyRegistry) private readonly _proxyRegistry: IProxyRegistry)

Parameters

Name	Type	Required
_proxyRegistry	IProxyRegistry	required

createInstance

methodprotected

protected override createInstance(
  dateProxyData: IDateProxyData,
  id: number
): IDateObserverProxyPair

Parameters

Name	Type	Required
dateProxyData	IDateProxyData	required
id	number	required

Returns

IDateObserverProxyPair

createUniqueId

methodprotected

protected override createUniqueId(_data: IDateProxyIdData): number

Parameters

Name	Type	Required
_data	IDateProxyIdData	required

Returns

number

getGroupId

methodprotected

protected override getGroupId(data: IDateProxyIdData): Date

Parameters

Name	Type	Required
data	IDateProxyIdData	required

Returns

Date

getGroupMemberId

methodprotected

protected override getGroupMemberId( data: IDateProxyIdData): IIndexWatchRule | undefined

Parameters

Name	Type	Required
data	IDateProxyIdData	required

Returns

IIndexWatchRule | undefined