@gjv/redux-slice-factory/src/models/meta-state/MetaState.ts

Generic factory functions for common slice data structures

import { SerializedError } from '@reduxjs/toolkit'
import StatusEnum from '../../constants/StatusEnum'

/**
 * @public
 */
export interface IMetaState <
    TStatusEnum extends keyof typeof StatusEnum | & string = keyof typeof StatusEnum,
    TError extends SerializedError = SerializedError
> {
    /**
     * The status of the slice.
     * @defaultValue `StatusEnum`
     */
    status: TStatusEnum;

    /**
     * The status of the slice.
     * @defaultValue `SerializedError`
     */
    error: TError | null;

    /**
     * The timestamp of the last time the slice was modified.
     */
    lastModified: string | null;

    /**
     * The timestamp of the last time the slice was hydrated.
     */
    lastHydrated: string | null;
}

const create = <
    TStatusEnum extends keyof typeof StatusEnum | & string = keyof typeof StatusEnum,
    TError extends SerializedError = SerializedError
> (args: Partial<IMetaState<TStatusEnum, TError>> = {}): IMetaState<TStatusEnum, TError> => ({
    status: args.status ?? StatusEnum.Settled as unknown as TStatusEnum,
    error: args.error ?? null,
    lastModified: args.lastModified ?? null,
    lastHydrated: args.lastHydrated ?? null,
})

/**
 * @public
 */
const MetaState = {
    create: create,
}

export default MetaState