Function createTravels

Create a new Travels instance

createTravels<
    S,
    F extends boolean = false,
    P extends { arrayLengthAssignment?: boolean; pathAsArray?: boolean } = {},
>(
    initialState: S,
    options?: Omit<TravelsOptions<F, true, P>, "autoArchive"> & {
        autoArchive?: true;
    },
): Travels<S, F, true, P>
Create a new Travels instance with auto archive mode
Type Parameters
- S
- F extends boolean = false
- P extends { arrayLengthAssignment?: boolean; pathAsArray?: boolean } = {}
Parameters
- initialState: S
- Optionaloptions: Omit<TravelsOptions<F, true, P>, "autoArchive"> & { autoArchive?: true }
Returns Travels<S, F, true, P>
- Defined in src/createTravels.ts:8
createTravels<
    S,
    F extends boolean = false,
    P extends { arrayLengthAssignment?: boolean; pathAsArray?: boolean } = {},
>(
    initialState: S,
    options: Omit<TravelsOptions<F, false, P>, "autoArchive"> & {
        autoArchive: false;
    },
): Travels<S, F, false, P>
Create a new Travels instance with manual archive mode
Type Parameters
- S
- F extends boolean = false
- P extends { arrayLengthAssignment?: boolean; pathAsArray?: boolean } = {}
Parameters
- initialState: S
- options: Omit<TravelsOptions<F, false, P>, "autoArchive"> & { autoArchive: false }
Returns Travels<S, F, false, P>
- Defined in src/createTravels.ts:22