@poap-xyz/utils - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

dist/cjs/index.d.ts

 export * from './types';
 export { PaginatedResult } from './types/pagination';
+export { nextCursor } from './functions/nextCursor';

dist/esm/index.d.ts

 export * from './types';
 export { PaginatedResult } from './types/pagination';
+export { nextCursor } from './functions/nextCursor';

dist/umd/index.d.ts

 export * from './types';
 export { PaginatedResult } from './types/pagination';
+export { nextCursor } from './functions/nextCursor';

dist/umd/index.js

@@ -14,5 +14,11 @@ (function (global, factory) {
 
+  function nextCursor(length, limit, offset) {
+      const endIndex = offset + length;
+      return endIndex < offset + limit ? null : endIndex;
+  }
+
   exports.PaginatedResult = PaginatedResult;
+  exports.nextCursor = nextCursor;
 
 }));
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@poap-xyz/utils",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Utils module for the poap.js library",
@@ -5,0 +5,0 @@ "type": "module",

README.md

@@ -5,12 +5,13 @@ # @poap-xyz/utils
 
-@poap-xyz/utils is a [short description of the purpose of the package].
+@poap-xyz/utils is a package that contains auxiliar functions.
 
 ## Features
 
-- Feature 1
-- Feature 2
-- Feature 3
+- PaginatedResult: A paginated interface that makes it easier to manage paginated results
+- SecureFetch: A wrapper for headers that inserts the authentication with POAP.
 
 ## Installation
 
+### NPM
+
 ```bash
@@ -20,19 +21,15 @@ npm install @poap-xyz/utils
 
-## Usage
+### Yarn
 
-\```python
-from package_name import module
+```bash
+yarn add @poap-xyz/utils
+```
 
-# Example usage
-result = module.function(parameter)
-print(result)
-\```
-
 ## Documentation
 
-For more detailed documentation, please visit [link to your documentation].
+For more detailed documentation, please visit [this link](https://documentation.poap.tech/docs).
 
 ## Examples
 
-For example scripts and usage, please check the `examples` folder.
+For example scripts and usage, please check the [examples](https://github.com/poap-xyz/poap.js/tree/main/examples).
 
@@ -39,0 +36,0 @@ ## Contributing

src/index.ts

 export * from './types';
 export { PaginatedResult } from './types/pagination';
+export { nextCursor } from './functions/nextCursor';

No alert changes

Improved metrics

Total package byte prevSize

10917

30.51%

Number of package files

27

17.39%

Lines of code

135

27.36%

Worsened metrics

Number of lines in readme file

41

-6.82%

No dependency changes