Function New

middleware/paginate/paginate.go:27–87

New creates a new pagination middleware handler.

(config ...Config)

// New creates a new pagination middleware handler.
func New(config ...Config) fiber.Handler {
	cfg := configDefault(config...)

	return func(c fiber.Ctx) error {
		if cfg.Next != nil && cfg.Next(c) {
			return c.Next()
		}

		appCfg := c.App().Config()

		limit := fiber.Query(c, cfg.LimitKey, cfg.DefaultLimit)
		if limit < 1 {
			limit = cfg.DefaultLimit
		}
		if limit > cfg.MaxLimit {
			limit = cfg.MaxLimit
		}

		sorts := parseSortQuery(c.Query(cfg.SortKey), cfg.AllowedSorts, cfg.DefaultSort)

		cursorRaw := c.Query(cfg.CursorKey)
		if cursorRaw == "" && cfg.CursorParam != "" {
			cursorRaw = c.Query(cfg.CursorParam)
		}

		if cursorRaw != "" {
			if len(cursorRaw) > maxCursorLen {
				return fiber.NewError(fiber.StatusBadRequest, "cursor too long")
			}

			data, err := base64.RawURLEncoding.DecodeString(cursorRaw)
			if err != nil {
				return fiber.NewError(fiber.StatusBadRequest, "invalid cursor")
			}
			var obj map[string]any
			if err := appCfg.JSONDecoder(data, &obj); err != nil {
				return fiber.NewError(fiber.StatusBadRequest, "invalid cursor")
			}

			pageInfo := &PageInfo{
				Limit:         limit,
				Sort:          sorts,
				Cursor:        cursorRaw,
				cursorData:    obj,
				jsonMarshal:   appCfg.JSONEncoder,
				jsonUnmarshal: appCfg.JSONDecoder,
			}
			fiber.StoreInContext(c, pageInfoKey, pageInfo)
			return c.Next()
		}

		page := max(fiber.Query(c, cfg.PageKey, cfg.DefaultPage), 1)
		offset := max(fiber.Query(c, cfg.OffsetKey, 0), 0)

		pageInfo := NewPageInfo(page, limit, offset, sorts)
		pageInfo.jsonMarshal = appCfg.JSONEncoder
		pageInfo.jsonUnmarshal = appCfg.JSONDecoder
		fiber.StoreInContext(c, pageInfoKey, pageInfo)