feat(pagination): add generic paginateArray helper to horizonPaginator (#618) - #809
Draft
s6pa1rta3n-lab wants to merge 1 commit into
Draft
feat(pagination): add generic paginateArray helper to horizonPaginator (#618)#809s6pa1rta3n-lab wants to merge 1 commit into
s6pa1rta3n-lab wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Implements a generic
paginateArrayhelper insrc/horizonPaginator.tsfor paginating in-memory arrays (such as local arrays of invoices or payments) with 1-indexed pagination, range boundary checks, andSdkErrorerror handling.Related Issue
Closes #618
Changes
src/horizonPaginator.tspaginateArray<T>(items: T[], opts: { page: number; pageSize: number })returningPaginateArrayResult<T>(data,total,totalPages,hasNext,hasPrev)pageSizeto be between 1 and 200, throwingSdkErrorwithSdkErrorCode.INVALID_RECIPIENTwhen invalidpagerequests returningdata: []without errorsPaginateArrayOptionsandPaginateArrayResulttypessrc/index.tspaginateArray,PaginateArrayOptions, andPaginateArrayResulton the public SDK entrypointtest/horizonPaginator.test.tstotalPagesand page < 1 returning empty arraypageSizeitemshasNextandhasPrevcorrectness across pagesSdkErrorwithINVALID_RECIPIENTcode whenpageSize < 1orpageSize > 200or non-integerpageSize = 1andpageSize = 200Invoice[],Payment[])Acceptance Criteria Checklist
paginateArray<T>(items: T[], opts: { page: number; pageSize: number }): { data: T[]; total: number; totalPages: number; hasNext: boolean; hasPrev: boolean }exported fromsrc/horizonPaginator.tspageis 1-indexed;page=1returns the firstpageSizeitemspage(beyondtotalPages) returnsdata: []without errorpageSizemust be between 1 and 200 — throwsSdkErrorwithINVALID_RECIPIENTcode otherwisesrc/index.tshasNext/hasPrevcorrectnessVerification Results
Payout Routing
0xF46C9F6d70C50BF81ef3588AB523a90a594a2F89GCL6OXAMLD75BMTINA6EMRUDWK5THQUSHMYNLSNBCJAPZJHNYJTUNIBC