🎩 You're Invited:Meet the Socket team at Black Hat in Las Vegas, August 3-6.RSVP
Sign In

@cuser/core

Package Overview
Dependencies
Maintainers
1
Versions
18
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@cuser/core

Core ipfs wrapper

Source
npmnpm
Version
0.0.31
Version published
Weekly downloads
3
-76.92%
Maintainers
1
Weekly downloads
 
Created
Source

cuser logo

@cuser/core

Status

codecov npm npm-downloads

Class: ClientCorePubSub

Creates pubsub to listen changes on cuser network

Hierarchy

  • ClientCorePubSub

Index

Constructors

Methods

Constructors

constructor

+ new ClientCorePubSub(node: IPFSAPI | Promise<IPFSAPI>, opts: CuserClientPubSubOptions): ClientCorePubSub

Defined in pubsub.js:72

Parameters:

NameType
nodeIPFSAPI | Promise<IPFSAPI>
optsCuserClientPubSubOptions

Returns: ClientCorePubSub

Methods

broadcast

broadcast(payload: any): void

Defined in pubsub.js:101

Parameters:

NameTypeDescription
payloadany

Returns: void

subscribe

subscribe(subscriber: (payload: Object) => void): (Anonymous function)

Defined in pubsub.js:107

Parameters:

NameTypeDescription
subscriber(payload: Object) => void

Returns: (Anonymous function)

Class: CuserCore

Core logic to manage the dag tree and specify the dag format, this will wraps ipfs.dag in order to normalize the mainly used methods and allows future replacements.

Hierarchy

  • CuserCore

Index

Constructors

Methods

Constructors

constructor

+ new CuserCore(node: IPFSAPI | Promise<IPFSAPI>, opts: CuserCoreOptions): CuserCore

Defined in core.js:28

Parameters:

NameType
nodeIPFSAPI | Promise<IPFSAPI>
optsCuserCoreOptions

Returns: CuserCore

Methods

get

get(cid: string, opts: AbortOptions): Promise<any>

Defined in core.js:91

Parameters:

NameType
cidstring
optsAbortOptions

Returns: Promise<any>

peerId

peerId(): Promise<string>

Defined in core.js:119

Gets the node peerId

Returns: Promise<string>

publish

publish(cid: string, opts: AbortOptions): Promise<PublishResult>

Defined in core.js:56

Publish using ipns to link the current cid to a fixed entry

Parameters:

NameType
cidstring
optsAbortOptions

Returns: Promise<PublishResult>

pubsub

pubsub(opts: CuserClientPubSubOptions): ClientCorePubSub

Defined in core.js:128

Parameters:

NameType
optsCuserClientPubSubOptions

Returns: ClientCorePubSub

put

put(value: any, opts: AbortOptions & PutOptions): Promise<string>

Defined in core.js:75

Parameters:

NameType
valueany
optsAbortOptions & PutOptions

Returns: Promise<string>

resolve

resolve(cid: string | Promise<string>): Promise<string>

Defined in core.js:106

Resolve the linked dag cid

Parameters:

NameType
cidstring | Promise<string>

Returns: Promise<string>

References

FAQs

Package last updated on 23 Dec 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts