Function createPatchableTravels

createPatchableTravels<
    S,
    F extends boolean = false,
    P extends { arrayLengthAssignment?: boolean; pathAsArray?: boolean } = {},
>(
    initialState: PatchableInput<S>,
    options?: Omit<
        TravelsOptions<F, true, P>,
        "controlledApply" | "autoArchive",
    > & { autoArchive?: true },
): Travels<S, F, true, P>
Create a Travels instance whose state is statically constrained to the durable JSON-shaped subset supported by patches and persistence.
Type Parameters
- S
- F extends boolean = false
- P extends { arrayLengthAssignment?: boolean; pathAsArray?: boolean } = {}
Parameters
- initialState: PatchableInput<S>
- Optionaloptions: Omit<TravelsOptions<F, true, P>, "controlledApply" | "autoArchive"> & {
  autoArchive?: true;
  }
Returns Travels<S, F, true, P>
- Defined in src/createPatchableTravels.ts:14
createPatchableTravels<
    S,
    F extends boolean = false,
    P extends { arrayLengthAssignment?: boolean; pathAsArray?: boolean } = {},
>(
    initialState: PatchableInput<S>,
    options: Omit<
        TravelsOptions<F, false, P>,
        "controlledApply" | "autoArchive",
    > & { autoArchive: false },
): Travels<S, F, false, P>
Create a Travels instance whose state is statically constrained to the durable JSON-shaped subset supported by patches and persistence.
Type Parameters
- S
- F extends boolean = false
- P extends { arrayLengthAssignment?: boolean; pathAsArray?: boolean } = {}
Parameters
- initialState: PatchableInput<S>
- options: Omit<TravelsOptions<F, false, P>, "controlledApply" | "autoArchive"> & {
  autoArchive: false;
  }
Returns Travels<S, F, false, P>
- Defined in src/createPatchableTravels.ts:28

Function createPatchableTravels

Type Parameters

Parameters

Returns Travels<S, F, true, P>

Type Parameters

Parameters

Returns Travels<S, F, false, P>

Settings