# @cuser/core

> Core ipfs wrapper

Latest version **0.0.36** (published 2020-12-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @cuser/core
pnpm add @cuser/core
yarn add @cuser/core
bun add @cuser/core
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.36 |
| Published | 2020-12-24 |
| First published | 2020-12-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 22.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | rubeniskov |
| Maintainers | rubeniskov |

## Links

- npm: https://www.npmjs.com/package/@cuser/core
- Repository: https://github.com/rubeniskov/cuser
- Homepage: https://github.com/rubeniskov/cuser#readme
- Issues: https://github.com/rubeniskov/cuser/issues
- npm.io page: https://npm.io/package/@cuser/core

## Dependencies (5)

- [cbor](https://npm.io/package/cbor.md) ^5.1.0
- [cids](https://npm.io/package/cids.md) ^1.0.2
- [debug](https://npm.io/package/debug.md) ^4.3.1
- [it-all](https://npm.io/package/it-all.md) ^1.0.4
- [ipfs-pubsub-room](https://npm.io/package/ipfs-pubsub-room.md) ^2.0.1

## Recent versions

- 0.0.36 (latest) — 2020-12-24
- 0.0.35 — 2020-12-23
- 0.0.34 — 2020-12-23
- 0.0.33 — 2020-12-23
- 0.0.32 — 2020-12-23
- 0.0.31 — 2020-12-23
- 0.0.30 — 2020-12-23
- 0.0.29 — 2020-12-23
- 0.0.27 — 2020-12-22
- 0.0.26 — 2020-12-22
- 0.0.25 — 2020-12-22
- 0.0.18 — 2020-12-22
- 0.0.17 — 2020-12-22
- 0.0.16 — 2020-12-22
- 0.0.12 — 2020-12-22
- … 3 more at https://npm.io/package/@cuser/core/versions

## README

<p align="center">
  <a href="./"><img width="250" src="https://raw.githubusercontent.com/rubeniskov/cuser/master/docs/logo.svg" alt="cuser logo" /></a>
</p>

# @cuser/core

## Status
[![codecov](https://codecov.io/gh/rubeniskov/cuser/branch/master/graph/badge.svg?flag=core)](https://codecov.io/gh/rubeniskov/cuser)
[![npm](https://img.shields.io/npm/v/@cuser/core.svg)](https://www.npmjs.com/package/@cuser/core)
[![npm-downloads](https://img.shields.io/npm/dw/@cuser/core)](https://www.npmjs.com/package/@cuser/core)
# Class: ClientCorePubSub

Creates pubsub to listen changes on cuser network

## Hierarchy

* **ClientCorePubSub**

## Index

### Constructors

* [constructor](docs/classes/clientcorepubsub.md#constructor)

### Methods

* [broadcast](docs/classes/clientcorepubsub.md#broadcast)
* [subscribe](docs/classes/clientcorepubsub.md#subscribe)

## Constructors

### constructor

\+ **new ClientCorePubSub**(`node`: IPFSAPI \| Promise<IPFSAPI\>, `opts`: CuserClientPubSubOptions): [ClientCorePubSub](docs/classes/clientcorepubsub.md)

*Defined in [pubsub.js:72](https://github.com/rubeniskov/cuser/blob/8b8610c/packages/core/pubsub.js#L72)*

#### Parameters:

Name | Type |
------ | ------ |
`node` | IPFSAPI \| Promise<IPFSAPI\> |
`opts` | CuserClientPubSubOptions |

**Returns:** [ClientCorePubSub](docs/classes/clientcorepubsub.md)

## Methods

### broadcast

▸ **broadcast**(`payload`: any): void

*Defined in [pubsub.js:101](https://github.com/rubeniskov/cuser/blob/8b8610c/packages/core/pubsub.js#L101)*

#### Parameters:

Name | Type | Description |
------ | ------ | ------ |
`payload` | any |   |

**Returns:** void

___

### subscribe

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

*Defined in [pubsub.js:107](https://github.com/rubeniskov/cuser/blob/8b8610c/packages/core/pubsub.js#L107)*

#### Parameters:

Name | Type | Description |
------ | ------ | ------ |
`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

* [constructor](docs/classes/cusercore.md#constructor)

### Methods

* [get](docs/classes/cusercore.md#get)
* [peerId](docs/classes/cusercore.md#peerid)
* [publish](docs/classes/cusercore.md#publish)
* [pubsub](docs/classes/cusercore.md#pubsub)
* [put](docs/classes/cusercore.md#put)
* [resolve](docs/classes/cusercore.md#resolve)

## Constructors

### constructor

\+ **new CuserCore**(`node`: IPFSAPI \| Promise<IPFSAPI\>, `opts`: CuserCoreOptions): [CuserCore](docs/classes/cusercore.md)

*Defined in [core.js:28](https://github.com/rubeniskov/cuser/blob/8b8610c/packages/core/core.js#L28)*

#### Parameters:

Name | Type |
------ | ------ |
`node` | IPFSAPI \| Promise<IPFSAPI\> |
`opts` | CuserCoreOptions |

**Returns:** [CuserCore](docs/classes/cusercore.md)

## Methods

### get

▸ **get**(`cid`: string, `opts`: AbortOptions): Promise<any\>

*Defined in [core.js:91](https://github.com/rubeniskov/cuser/blob/8b8610c/packages/core/core.js#L91)*

#### Parameters:

Name | Type |
------ | ------ |
`cid` | string |
`opts` | AbortOptions |

**Returns:** Promise<any\>

___

### peerId

▸ **peerId**(): Promise<string\>

*Defined in [core.js:119](https://github.com/rubeniskov/cuser/blob/8b8610c/packages/core/core.js#L119)*

Gets the node peerId

**Returns:** Promise<string\>

___

### publish

▸ **publish**(`cid`: string, `opts`: AbortOptions): Promise<PublishResult\>

*Defined in [core.js:56](https://github.com/rubeniskov/cuser/blob/8b8610c/packages/core/core.js#L56)*

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

#### Parameters:

Name | Type |
------ | ------ |
`cid` | string |
`opts` | AbortOptions |

**Returns:** Promise<PublishResult\>

___

### pubsub

▸ **pubsub**(`opts`: CuserClientPubSubOptions): [ClientCorePubSub](docs/classes/clientcorepubsub.md)

*Defined in [core.js:128](https://github.com/rubeniskov/cuser/blob/8b8610c/packages/core/core.js#L128)*

#### Parameters:

Name | Type |
------ | ------ |
`opts` | CuserClientPubSubOptions |

**Returns:** [ClientCorePubSub](docs/classes/clientcorepubsub.md)

___

### put

▸ **put**(`value`: any, `opts`: AbortOptions & PutOptions): Promise<string\>

*Defined in [core.js:75](https://github.com/rubeniskov/cuser/blob/8b8610c/packages/core/core.js#L75)*

#### Parameters:

Name | Type |
------ | ------ |
`value` | any |
`opts` | AbortOptions & PutOptions |

**Returns:** Promise<string\>

___

### resolve

▸ **resolve**(`cid`: string \| Promise<string\>): Promise<string\>

*Defined in [core.js:106](https://github.com/rubeniskov/cuser/blob/8b8610c/packages/core/core.js#L106)*

Resolve the linked dag cid

#### Parameters:

Name | Type |
------ | ------ |
`cid` | string \| Promise<string\> |

**Returns:** Promise<string\>
### References

- https://github.com/ipfs/js-ipfs#documentation
- https://github.com/ipfs/ipfs-docs/issues/242

---
_Source: https://npm.io/package/@cuser/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._