Skip to content

docs: clarify forEachSlice callback - #305

Open
dajiaohuang wants to merge 1 commit into
tinyplex:mainfrom
dajiaohuang:docs/index-for-each-slice-description
Open

docs: clarify forEachSlice callback#305
dajiaohuang wants to merge 1 commit into
tinyplex:mainfrom
dajiaohuang:docs/index-for-each-slice-description

Conversation

@dajiaohuang

Copy link
Copy Markdown

The Indexes.forEachSlice API prose referred to a rowCallback and row value, although the declaration and example expose a sliceCallback that receives a slice Id and row iterator. This updates the source documentation to match the actual API.

Fixes #304

Validation: npm run lintDocs, node --check src/@types/indexes/docs.js, and npm run compileForTest pass. npm run testDocs passes 5 of 6 documentation examples; the releases example requires a local PostgreSQL server (ECONNREFUSED on localhost:5432).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify the forEachSlice callback in the Indexes API docs

1 participant