Skip to content

Commit

Permalink
fix some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
fatihozer0 committed Nov 15, 2022
1 parent 0c10951 commit 511a93f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions src/proxy/Ringbuffer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -156,18 +156,18 @@ export interface Ringbuffer<E> extends DistributedObject {
* until further items become available, and it can read at least the
* minimum number of items.
*
* filter` argument is provided to select only the items that are needed
* `filter` argument is provided to select only the items that are needed
* to be read. If the filter is not provided, all items will be read.
* Otherwise, only the items where the filter function returns true are returned.
* Using filters is a good way to prevent getting items that are of no value
* to the receiver. amount of IO and the number of operations being executed
* to the receiver. This reduces the amount of IO and the number of operations being executed,
* and can result in a significant performance improvement. Note that,
* filtering logic must be defined on the server-side.
*
* @param startSequence sequence number of the first item to be read.
* @param minCount minimum number of items to be read.
* @param maxCount maximum number of items to be read.
* @param filter optional filter to be applied to the items
* @param filter optional filter to be applied to the items
* @throws RangeError if `startSequence` is smaller than `0`,
* or if `minCount` smaller than `0`,
* or if `minCount` larger than `maxCount`,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ describe('RingbufferProxyTest', function () {
expect(size.toNumber()).to.equal(2);
});

it('correctly works with prefix filter', async function () {
it('readMany correctly works with a filter', async function () {
await rb.addAll(['item1', 'prefixedItem2', 'prefixedItem3']);
const items = await rb.readMany(0, 1, 3, new PrefixFilter('prefixed'));
expect(items.get(0)).to.equal('prefixedItem2');
Expand Down

0 comments on commit 511a93f

Please sign in to comment.