Socket
Socket
Sign inDemoInstall

@rss3/js-sdk

Package Overview
Dependencies
Maintainers
3
Versions
75
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@rss3/js-sdk - npm Package Compare versions

Comparing version 0.0.1 to 0.4.0

./dist/index.mjs

63

package.json
{
"name": "@rss3/js-sdk",
"type": "module",
"version": "0.0.1",
"version": "0.4.0",
"main": "./dist/index.mjs",
"module": "./dist/index.mjs",
"types": "./dist/index.d.ts",
"typesVersions": {
"*": {
"*": [
"./dist/*",
"./dist/index.d.ts"
]
}
},
"exports": {
"./*": "./src/*"
".": {
"types": "./dist/index.d.ts",
"require": "./dist/index.cjs",
"import": "./dist/index.mjs"
},
"./utils": {
"types": "./dist/utils.d.ts",
"require": "./dist/utils.cjs",
"import": "./dist/utils.mjs"
},
"./types": {
"types": "./dist/types.d.ts",
"require": "./dist/types.cjs",
"import": "./dist/types.mjs"
}
},
"description": "js sdk for rss3 services",
"files": [
"dist"
],
"dependencies": {
"openapi-fetch": "^0.6.0"
},
"devDependencies": {
"@kecrily/eslint-config": "^0.2.6",
"@types/node": "^20.3.2",
"eslint": "^8.43.0",
"typescript": "^5.0.4",
"unbuild": "^1.2.1",
"vitest": "^0.32.2"
},
"eslintConfig": {
"extends": "@kecrily",
"ignorePatterns": [
"src/types/data.ts",
"src/types/search.ts"
]
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
"dev": "unbuild --stub",
"build": "unbuild",
"test": "vitest",
"typecheck": "tsc --noEmit",
"lint": "eslint . --cache"
}
}

@@ -1,3 +0,54 @@

# Overview
# index-sdk
The JS SDK for rss3 services.
index-sdk is designed to simplify the development process and enable developers to interact with RSS3 API efficiently
## Usage
```sh
# npm
npm i index-sdk
# yarn
yarn add index-sdk
# pnpm
pnpm add index-sdk
```
If you want to customize the endpoint, you can:
```ts
import { IndexClient } from 'index-sdk'
const index = new IndexClient({ endpoint: { data: 'https://test-pregod.rss3.dev/v1' } })
```
And of course you can also use [all of fetch options (`RequestInit`)](https://developer.mozilla.org/en-US/docs/Web/API/fetch#options).
## Examples
### Get all of Vitalik's profiles on Web3
```ts
import { IndexClient } from 'index-sdk'
const index = new IndexClient()
const { result: profiles } = await index.profiles.get('vitalik.eth')
```
Now you know where to find Vitalik!
### Get all notes posted by DIYgod on xLog
```ts
import { IndexClient } from 'index-sdk'
const index = new IndexClient()
const { result: notes } = await index.notes.get('diygod.eth', {
platform: ['xLog']
})
```
Now you can even use xLog as a headless CMS
.prettierrc
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc