Documentation / @andrew_l/mongo-pagination / TokenOptions

Interface: TokenOptions

Properties

modelName?

optional modelName: string

The name of the model the token is related to.

---

payload

payload: null | Record<string, any>

The payload of the token. Contains additional data or metadata (can be null).

---

schemaVersion

schemaVersion: number

The schema version of the token.

---

sortDirection?

optional sortDirection: Record<string, any>

The sorting direction used to building pagination query.

---

sortValues?

optional sortValues: Record<string, any>

The values associated with sorting. Used in conjunction with sortDirection to building range query.