{"id":23662789,"url":"https://github.com/plebbit/plebbit-js","last_synced_at":"2025-04-10T04:56:32.815Z","repository":{"id":39748155,"uuid":"449483022","full_name":"plebbit/plebbit-js","owner":"plebbit","description":"A Javascript API to build applications using plebbit","archived":false,"fork":false,"pushed_at":"2025-03-17T11:18:11.000Z","size":18882,"stargazers_count":48,"open_issues_count":28,"forks_count":9,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-03T03:09:13.903Z","etag":null,"topics":["content-sharing","decentralized-p2p","ipfs","javascript","nodejs","plebbit","plebbit-js","reddit-alternative","social-network","typescript"],"latest_commit_sha":null,"homepage":"https://plebbit.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/plebbit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-18T23:40:42.000Z","updated_at":"2025-03-23T12:14:17.000Z","dependencies_parsed_at":"2024-05-05T13:25:29.758Z","dependency_job_id":"2c34ccba-e8c9-48f0-a9d1-0425321dffc6","html_url":"https://github.com/plebbit/plebbit-js","commit_stats":{"total_commits":2041,"total_committers":6,"mean_commits":340.1666666666667,"dds":"0.23468887800097993","last_synced_commit":"ae991eeb4f2ccc4ba3cceb692dc8252b43362a3e"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plebbit%2Fplebbit-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plebbit%2Fplebbit-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plebbit%2Fplebbit-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plebbit%2Fplebbit-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/plebbit","download_url":"https://codeload.github.com/plebbit/plebbit-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248161261,"owners_count":21057554,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["content-sharing","decentralized-p2p","ipfs","javascript","nodejs","plebbit","plebbit-js","reddit-alternative","social-network","typescript"],"created_at":"2024-12-29T05:13:44.723Z","updated_at":"2025-04-10T04:56:32.794Z","avatar_url":"https://github.com/plebbit.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"*Telegram group for this repo https://t.me/plebbitjs*\n\n`plebbit-js` is an NPM module to wrap around the IPFS APIs used by plebbit. It is used in all clients: CLI, Electron (desktop GUI) and web.\n\n### Glossary:\n\n- CID: https://docs.ipfs.io/concepts/content-addressing/\n- IPNS: https://docs.ipfs.io/concepts/ipns/#example-ipns-setup-with-cli\n- IPNS name: hash of a public key, the private key is used by subplebbit owners for signing IPNS records, and by authors for signing posts and comments\n- Pubsub topic: the string to publish/subscribe to in the pubsub https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/PUBSUB.md#ipfspubsubsubscribetopic-handler-options and https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.0.md#topic-membership\n- IPNS record: https://github.com/ipfs/specs/blob/master/IPNS.md#ipns-record\n- IPNS signature: https://github.com/ipfs/notes/issues/249\n- Plebbit signature types: https://github.com/plebbit/plebbit-js/blob/master/docs/signatures.md\n- Plebbit encryption types: https://github.com/plebbit/plebbit-js/blob/master/docs/encryption.md\n\nNote: IPFS files are immutable, fetched by their CID, which is a hash of their content. IPNS records are mutable, fetched by their IPNS name, which is the hash of a public key. The private key's owner can update the content. Always use IPFS files over IPNS records when possible because they are much faster to fetch.\n\n### Schema:\n\n```js\nAddress: string // a plebbit author, subplebbit or multisub \"address\" can be a crypto domain like memes.eth, an IPNS name, an ethereum address, etc. How to resolve ENS names https://github.com/plebbit/plebbit-js/blob/master/docs/ens.md\nPublication {\n  author: Author\n  subplebbitAddress: string // all publications are directed to a subplebbit owner\n  timestamp: number // number in seconds\n  signature: Signature // sign immutable fields like author, title, content, timestamp to prevent tampering\n  protocolVersion: '1.0.0' // semantic version of the protocol https://semver.org/\n}\nComment extends Publication /* (IPFS file) */ {\n  parentCid?: string // same as postCid for top level comments, undefined for posts\n  content?: string\n  title?: string\n  link?: string\n  linkWidth?: number // author can optionally provide dimensions of image/video link which helps UI clients with infinite scrolling feeds\n  linkHeight?: number\n  linkHtmlTagName?: 'a' | 'img' | 'video' | 'audio' // author can optionally provide the HTML element to use for the link\n  spoiler?: boolean\n  flair?: Flair // arbitrary colored string added by the author or mods to describe the author or comment\n  // below are added by subplebbit owner, not author\n  previousCid?: string // each comment/post is a linked list of other comments/posts with same comment.depth and comment.parentCid, undefined if first comment in list\n  postCid?: string // helps faster loading post info for reply direct linking, undefined for posts, a post can't know its own CID\n  depth: number // 0 = post, 1 = top level reply, 2+ = nested reply\n  thumbnailUrl?: string // optionally fetched by subplebbit owner, some web pages have thumbnail urls in their meta tags https://moz.com/blog/meta-data-templates-123\n  thumbnailUrlWidth?: number // subplebbit owner can optionally provide dimensions of thumbails which helps UI clients with infinite scrolling feeds\n  thumbnailUrlHeight?: number\n}\nVote extends Publication {\n  commentCid: string\n  vote: 1 | -1 | 0 // 0 is needed to cancel a vote\n}\nCommentEdit extends Publication {\n  commentCid: string\n  content?: string\n  deleted?: boolean\n  flair?: Flair\n  spoiler?: boolean\n  reason?: string\n}\nCommentModeration extends Publication {\n  commentCid: string\n  commentModeration: {\n    flair?: Flair\n    spoiler?: boolean\n    pinned?: boolean\n    locked?: boolean\n    removed?: boolean\n    reason?: string\n    author?: {\n      flair?: Flair\n      banExpiresAt?: number\n    }  \n  }\n}\nSubplebbitEdit extends Publication {\n  subplebbitEdit: CreateSubplebbitOptions\n}\nMultisubEdit extends CreateMultisubOptions, Publication {}\nCommentUpdate /* (IPFS file) */ {\n  cid: string // cid of the comment, need it in signature to prevent attack\n  edit?: AuthorCommentEdit // most recent edit by comment author, commentUpdate.edit.content, commentUpdate.edit.deleted, commentUpdate.edit.flair override Comment instance props. Validate commentUpdate.edit.signature\n  upvoteCount: number\n  downvoteCount: number\n  replies?: Pages // only preload page 1 sorted by 'topAll', might preload more later, only provide sorting for posts (not comments) that have 100+ child comments\n  replyCount: number\n  flair?: Flair // arbitrary colored string to describe the comment, added by mods, override comment.flair (which are added by author)\n  spoiler?: boolean\n  pinned?: boolean\n  locked?: boolean\n  removed?: boolean // mod deleted a comment\n  reason?: string // reason the mod took a mod action\n  updatedAt: number // timestamp in seconds the IPNS record was updated\n  protocolVersion: '1.0.0' // semantic version of the protocol https://semver.org/\n  signature: Signature // signature of the CommentUpdate by the sub owner to protect against malicious gateway\n  author?: { // add commentUpdate.author.subplebbit to comment.author.subplebbit, override comment.author.flair with commentUpdate.author.subplebbit.flair if any\n    subplebbit: SubplebbitAuthor\n  }\n  lastReplyTimestamp?: number // needed for active sort in frontend\n  lastChildCid?: number // needed to fetch reply updates using subplebbit.postUpdates https://github.com/plebbit/plebbit-js/issues/12\n}\nAuthor {\n  address: string\n  shortAddress: string // not part of IPFS files, added to `Author` instance as convenience. Copy address, if address is a hash, remove hash prefix and trim to 12 first chars\n  previousCommentCid?: string // linked list of the author's comments\n  displayName?: string\n  wallets?: {[chainTicker: string]: Wallet}\n  avatar?: Nft\n  flair?: Flair // (added added by author originally, can be overriden by commentUpdate.subplebbit.author.flair)\n  subplebbit?: SubplebbitAuthor // (added by CommentUpdate) up to date author properties specific to the subplebbit it's in\n}\nSubplebbitAuthor {\n  banExpiresAt?: number // (added by moderator only) timestamp in second, if defined the author was banned for this comment\n  flair?: Flair // (added by moderator only) for when a mod wants to edit an author's flair\n  postScore: number // total post karma in the subplebbit\n  replyScore: number // total reply karma in the subplebbit\n  lastCommentCid: string // last comment by the author in the subplebbit, can be used with author.previousCommentCid to get a recent author comment history in all subplebbits\n  firstCommentTimestamp: number // timestamp of the first comment by the author in the subplebbit, used for account age based challenges\n}\nWallet {\n  address: string\n  timestamp: number // in seconds, allows partial blocking multiple authors using the same wallet\n  signature: Signature // type 'eip191' {domainSeparator:\"plebbit-author-wallet\",authorAddress:\"${authorAddress}\",\"{timestamp:${wallet.timestamp}\"}\n  // ...will add more stuff later, like signer or send/sign or balance\n}\nNft {\n  chainTicker: string // ticker of the chain, like eth, avax, sol, etc in lowercase\n  timestamp: number // in seconds, needed to mitigate multiple users using the same signature\n  address: string // address of the NFT contract\n  id: string // tokenId or index of the specific NFT used, must be string type, not number\n  signature: Signature // proof that author.address owns the nft\n  // how to resolve and verify NFT signatures https://github.com/plebbit/plebbit-js/blob/master/docs/nft.md\n}\nSignature {\n  signature: string // data in base64\n  publicKey: string // 32 bytes base64 string\n  type: 'ed25519' | 'eip191' // multiple versions/types to allow signing with metamask/other wallet or to change the signature fields or algorithm\n  signedPropertyNames: string[] // the fields that were signed as part of the signature e.g. ['title', 'content', 'author', etc.] client should require that certain fields be signed or reject the publication, e.g. 'content', 'author', 'timestamp' are essential\n}\nSigner {\n  privateKey?: string // 32 bytes base64 string\n  type: 'ed25519' | 'eip191' // multiple versions/types to allow signing with metamask/other wallet or to change the signature fields or algorithm https://eips.ethereum.org/EIPS/eip-191\n  publicKey?: string // 32 bytes base64 string\n  address: string // public key hash, not needed for signing\n  ipfsKey?: IpfsKey // a Key object used for importing into IpfsHttpClient https://docs.ipfs.io/reference/cli/#ipfs-key-import\n}\nSubplebbit /* (IPNS record Subplebbit.address) */ {\n  address: string // validate subplebbit address in signature to prevent a crypto domain resolving to an impersonated subplebbit\n  title?: string\n  description?: string\n  roles?: {[authorAddress: string]: SubplebbitRole} // each author address can be mapped to 1 SubplebbitRole\n  pubsubTopic?: string // the string to publish to in the pubsub, a public key of the subplebbit owner's choice\n  lastPostCid?: string // the most recent post in the linked list of posts\n  lastCommentCid?: string // the most recent comment (posts and replies included), last comment is often displayed with a list of forums\n  posts?: Pages // only preload page 1 sorted by 'hot', might preload more later, comments should include Comment + CommentUpdate data\n  statsCid?: string\n  createdAt: number\n  updatedAt: number\n  features?: SubplebbitFeatures\n  suggested?: SubplebbitSuggested\n  rules?: string[]\n  flairs?: {[key: 'post' | 'author']: Flair[]} // list of post/author flairs authors and mods can choose from\n  protocolVersion: '1.0.0' // semantic version of the protocol https://semver.org/\n  encryption: SubplebbitEncryption\n  signature: Signature // signature of the Subplebbit update by the sub owner to protect against malicious gateway\n}\nSubplebbitSuggested { // values suggested by the sub owner, the client/user can ignore them without breaking interoperability\n  primaryColor?: string\n  secondaryColor?: string\n  avatarUrl?: string\n  bannerUrl?: string\n  backgroundUrl?: string\n  language?: string\n  // TODO: menu links, wiki pages, sidebar widgets\n}\nSubplebbitFeatures { // any boolean that changes the functionality of the sub, add \"no\" in front if doesn't default to false\n  // implemented\n  noUpvotes?: boolean\n  noPostUpvotes?: boolean\n  noReplyUpvotes?: boolean\n  noDownvotes?: boolean\n  noPostDownvotes?: boolean\n  noReplyDownvotes?: boolean\n  requirePostLink?: boolean // require post.link be defined and a valid https url\n  requirePostLinkIsMedia?: boolean // require post.link be media, e.g. for imageboards\n  // not implemented\n  noVideos?: boolean\n  noSpoilers?: boolean // author can't comment.spoiler = true their own comments\n  noImages?: boolean\n  noVideoReplies?: boolean\n  noSpoilerReplies?: boolean\n  noImageReplies?: boolean\n  noPolls?: boolean\n  noCrossposts?: boolean\n  noAuthors?: boolean // no authors at all, like 4chan\n  anonymousAuthors?: boolean // authors are given anonymous ids inside threads, like 4chan\n  noNestedReplies?: boolean // no nested replies, like old school forums and 4chan\n  safeForWork?: boolean\n  authorFlairs?: boolean // authors can choose their own author flairs (otherwise only mods can)\n  requireAuthorFlairs?: boolean // force authors to choose an author flair before posting\n  postFlairs?: boolean // authors can choose their own post flairs (otherwise only mods can)\n  requirePostFlairs?: boolean // force authors to choose a post flair before posting\n  noMarkdownImages?: boolean // don't embed images in text posts markdown\n  noMarkdownVideos?: boolean // don't embed videos in text posts markdown\n  markdownImageReplies?: boolean\n  markdownVideoReplies?: boolean\n}\nSubplebbitEncryption {\n  type: 'ed25519-aes-gcm' // https://github.com/plebbit/plebbit-js/blob/master/docs/encryption.md\n  publicKey: string // 32 bytes base64 string\n}\nSubplebbitRole {\n  role: 'owner' | 'admin' | 'moderator'\n  // TODO: custom roles with other props\n}\nFlair {\n  text: string\n  backgroundColor?: string\n  textColor?: string\n  expiresAt?: timestamp in second, a flair assigned to an author by a mod will follow the author in future comments, unless it expires\n}\nPages {\n  pages: {[key: PostsSortType | RepliesSortType]: Page} // e.g. subplebbit.posts.pages.hot.comments[0].cid = '12D3KooW...'\n  pageCids: {[key: PostsSortType | RepliesSortType | ModSortType]: pageCid} // e.g. subplebbit.posts.pageCids.topAll = '12D3KooW...'\n}\nPage {\n  nextCid: string // get next page (sorted by the same sort type)\n  comments: Comment[] // Comments should include merged Comment and CommentUpdate\n}\nPageIpfs /* (IPFS file) */ {\n  nextCid: string // get next page (sorted by the same sort type)\n  comments: PageIpfsComment[] // PageIpfs is fetched from IPFS, then Comments and CommentUpdates are merged to create the Page instance\n}\nPageIpfsComment {\n  comment: Comment\n  commentUpdate: CommentUpdate\n}\nPostsSortType: 'hot' | 'new' | 'active' | 'topHour' | 'topDay' | 'topWeek' | 'topMonth' | 'topYear' | 'topAll' | 'controversialHour' | 'controversialDay' | 'controversialWeek' | 'controversialMonth' | 'controversialYear' | 'controversialAll'\nRepliesSortType: 'topAll' | 'new' | 'old' | 'controversialAll'\nModSortType: 'reports' | 'spam' | 'modqueue' | 'unmoderated' | 'edited'\nSubplebbitStats {\n  hourActiveUserCount: number\n  dayActiveUserCount: number\n  weekActiveUserCount: number\n  monthActiveUserCount: number\n  yearActiveUserCount: number\n  allActiveUserCount: number\n  hourPostCount: number\n  dayPostCount: number\n  weekPostCount: number\n  monthPostCount: number\n  yearPostCount: number\n  allPostCount: number\n  hourReplyCount: number\n  dayReplyCount: number\n  weekReplyCount: number\n  monthReplyCount: number\n  yearReplyCount: number\n  allReplyCount: number\n}\nChallengeType {\n  type: 'image/png' | 'text/plain' | 'chain/\u003cchainTicker\u003e'\n  //...other properties for more complex types later, e.g. an array of whitelisted addresses, a token address, etc,\n}\nMultisub /* (IPNS record Multisub.address) */ {\n  title?: string\n  description?: string\n  subplebbits: MultisubSubplebbit[]\n  createdAt: number\n  updatedAt: number\n  signature: Signature // signature of the Multisub update by the multisub owner to protect against malicious gateway\n}\nMultisubSubplebbit { // this metadata is set by the owner of the Multisub, not the owner of the subplebbit\n  address: Address\n  title?: string\n  description?: string \n  languages?: string[] // client can detect language and hide/show subplebbit based on it\n  locations?: string[] // client can detect location and hide/show subplebbit based on it\n  features?: string[] // client can detect user's SFW setting and hide/show subplebbit based on it\n  tags?: string[] // arbitrary keywords used for search\n}\nPlebbitDefaults { // fetched once when app first load, a dictionary of default settings\n  multisubAddresses: {[multisubName: string]: Address}\n  // plebbit has 3 default multisubs\n  multisubAddresses.all: Address // the default subplebbits to show at url plebbit.eth/p/all\n  multisubAddresses.crypto: Address // the subplebbits to show at url plebbit.eth/p/crypto\n  multisubAddresses.search: Address // list of thousands of semi-curated subplebbits to \"search\" for in the client (only search the Multisub metadata, don't load each subplebbit)\n}\n```\n\n### Pubsub message types\n\n```js\nPubsubMessage: {\n  type: 'CHALLENGEREQUEST' | 'CHALLENGE' | 'CHALLENGEANSWER' | 'CHALLENGEVERIFICATION'\n  challengeRequestId: Uint8Array // (byte string in cbor) // multihash of challengeRequestMessage.signature.publicKey, each challengeRequestMessage must use a new public key\n  timestamp: number // in seconds, needed because publication.timestamp is encrypted\n  signature: PubsubSignature // each challengeRequestMessage must use a new public key\n  protocolVersion: '1.0.0' // semantic version of the protocol https://semver.org/\n  userAgent: `/plebbit-js:${require('./package.json').version}/` // client name and version using this standard https://en.bitcoin.it/wiki/BIP_0014#Proposal\n}\nChallengeRequestMessage extends PubsubMessage /* (sent by post author) */ {\n  acceptedChallengeTypes: string[] // list of challenge types the client can do, for example cli clients or old clients won't do all types\n  encrypted: Encrypted\n  /* ChallengeRequestMessage.encrypted.ciphertext decrypts to JSON {\n    comment?: Comment\n    vote?: Vote\n    commentEdit?: CommentEdit\n    commentModeration?: CommentModeration\n    subplebbitEdit?: SubplebbitEdit\n    challengeAnswers?: string[] // some challenges might be included in subplebbit.challenges and can be pre-answered\n    challengeCommentCids?: string[] // some challenges could require including comment cids in other subs, like friendly subplebbit karma challenges\n  }\n  plebbit-js should decrypt the encrypted fields when possible, and add `ChallengeRequestMessage.publication` property for convenience (not part of the broadcasted pubsub message) */\n}\nChallengeMessage extends PubsubMessage /* (sent by subplebbit owner) */ {\n  encrypted: Encrypted\n  /* ChallengeMessage.encrypted.ciphertext decrypts to JSON {\n    challenges: Challenge[]\n  }\n  plebbit-js should decrypt the encrypted fields when possible, and add `ChallengeMessage.challenges` property for convenience (not part of the broadcasted pubsub message) */\n}\nChallengeAnswerMessage extends PubsubMessage /* (sent by post author) */ {\n  encrypted: Encrypted\n  /* ChallengeAnswerMessage.encrypted.ciphertext decrypts to JSON {\n    challengeAnswers: string[] // for example ['2+2=4', '1+7=8']\n  }\n  plebbit-js should decrypt the encrypted fields when possible, and add `ChallengeAnswerMessage.challengeAnswers` property for convenience (not part of the broadcasted pubsub message) */\n}\nChallengeVerificationMessage extends PubsubMessage /* (sent by subplebbit owner) */ {\n  challengeSuccess: bool // true if the challenge was successfully completed by the requester\n  challengeErrors?: (string|undefined)[] // tell the user which challenge failed and why\n  reason?: string // reason for failed verification, for example post content is too long. could also be used for successful verification that bypass the challenge, for example because an author has good history\n  encrypted: Encrypted\n  /* ChallengeVerificationMessage.encrypted.ciphertext decrypts to JSON {\n    comment?: Comment // must contain missing props from comment publication, like depth, postCid, etc\n    commentUpdate?: CommentUpdate // must contain commentUpdate.cid and commentUpdate.signature when publication is comment\n  }\n  plebbit-js should decrypt the encrypted fields when possible, and add `ChallengeVerificationMessage.publication` property for convenience (not part of the broadcasted pubsub message) */\n}\nChallenge {\n  type: 'image/png' | 'text/plain' | 'chain/\u003cchainTicker\u003e' // tells the client how to display the challenge, start with implementing image and text only first\n  challenge: string // base64 or utf8 required to complete the challenge, could be html, png, etc.\n  caseInsensitive?: boolean // challenge answer capitalization is ignored, informational only option added by the challenge file\n}\nEncrypted {\n  // examples available at https://github.com/plebbit/plebbit-js/blob/master/docs/encryption.md\n  ciphertext: Uint8Array // (byte string in cbor) encrypted byte string with AES GCM 128 // https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Galois/counter_(GCM)\n  iv: Uint8Array // (byte string in cbor) iv for the AES GCM 128 encrypted content\n  tag: Uint8Array // (byte string in cbor) authentication tag, AES GCM has authentication tag https://en.wikipedia.org/wiki/Galois/Counter_Mode\n  type: 'ed25519-aes-gcm'\n}\nPubsubSignature {\n  signature: Uint8Array // (byte string in cbor)\n  publicKey: Uint8Array // (byte string in cbor) 32 bytes\n  type: 'ed25519' | 'eip191' // multiple versions/types to allow signing with metamask/other wallet or to change the signature fields or algorithm\n  signedPropertyNames: string[] // the fields that were signed as part of the signature e.g. ['title', 'content', 'author', etc.] client should require that certain fields be signed or reject the publication, e.g. 'content', 'author', 'timestamp' are essential\n}\n```\n\n# API\n\n- [Plebbit API](#plebbit-api)\n  - [`Plebbit(plebbitOptions)`](#plebbitplebbitoptions)\n  - [`plebbit.getMultisub(multisubAddress)`](#plebbitgetmultisubmultisubaddress)\n  - [`plebbit.getSubplebbit(subplebbitAddress)`](#plebbitgetsubplebbitsubplebbitaddress)\n  - [`plebbit.getComment(commentCid)`](#plebbitgetcommentcommentcid)\n  - [`plebbit.createMultisub(createMultisubOptions)`](#plebbitcreatemultisubcreatemultisuboptions)\n  - [`plebbit.createSubplebbit(createSubplebbitOptions)`](#plebbitcreatesubplebbitcreatesubplebbitoptions)\n  - [`plebbit.createSubplebbitEdit(createSubplebbitEditOptions)`](#plebbitcreatesubplebbiteditcreatesubplebbiteditoptions)\n  - [`plebbit.createComment(createCommentOptions)`](#plebbitcreatecommentcreatecommentoptions)\n  - [`plebbit.createCommentEdit(createCommentEditOptions)`](#plebbitcreatecommenteditcreatecommenteditoptions)\n  - [`plebbit.createCommentModeration(createCommentModerationOptions)`](#plebbitcreatecommentmoderationcreatecommentmoderationoptions)\n  - [`plebbit.createVote(createVoteOptions)`](#plebbitcreatevotecreatevoteoptions)\n  - [`plebbit.createSigner(createSignerOptions)`](#plebbitcreatesignercreatesigneroptions)\n  - `plebbit.subplebbits`\n  - `plebbit.clients`\n  - [`plebbit.getDefaults()`](#plebbitgetdefaults)\n  - `plebbit.fetchCid(cid)`\n  - `plebbit.resolveAuthorAddress(address)`\n  - `Plebbit.getShortAddress(address)`\n  - `Plebbit.getShortCid(cid)`\n  - `Plebbit.setNativeFunctions(nativeFunctions)`\n  - `Plebbit.nativeFunctions`\n  - `Plebbit.challenges`\n- [Plebbit Events](#plebbit-events)\n  - [`subplebbitschange`](#subplebbitschange)\n  - `error`\n- [Subplebbit API](#subplebbit-api)\n  - [`subplebbit.edit(subplebbitEditOptions)`](#subplebbiteditsubplebbiteditoptions)\n  - [`subplebbit.start()`](#subplebbitstart)\n  - [`subplebbit.stop()`](#subplebbitstop)\n  - [`subplebbit.update()`](#subplebbitupdate)\n  - `subplebbit.delete()`\n  - `subplebbit.address`\n  - `subplebbit.shortAddress`\n  - `subplebbit.roles`\n  - `subplebbit.posts`\n  - `subplebbit.lastPostCid`\n  - `subplebbit.pubsubTopic`\n  - `subplebbit.rules`\n  - `subplebbit.flairs`\n  - `subplebbit.suggested`\n  - `subplebbit.features`\n  - `subplebbit.settings`\n  - `subplebbit.createdAt`\n  - `subplebbit.updatedAt`\n  - `subplebbit.statsCid`\n  - `subplebbit.updateCid`\n  - `subplebbit.signer`\n  - `subplebbit.started`\n  - `subplebbit.state`\n  - `subplebbit.updatingState`\n  - `subplebbit.startedState`  \n- [Subplebbit Events](#subplebbit-events)\n  - [`update`](#update)\n  - [`challengerequest`](#challengerequest)\n  - [`challengeanswer`](#challengeanswer)\n  - `challenge`\n  - `challengeverification`\n  - `error`\n  - [`statechange`](#statechange)\n  - [`updatingstatechange`](#updatingstatechange)\n  - [`startedstatechange`](#startedstatechange)\n- [Comment API](#comment-api)\n  - [`comment.publish()`](#commentpublish)\n  - [`comment.publishChallengeAnswers()`](#commentpublishchallengeanswerschallengeanswers)\n  - [`comment.update()`](#commentupdate)\n  - [`comment.stop()`](#commentstop)\n  - `comment.author`\n  - `comment.timestamp`\n  - `comment.signature`\n  - `comment.previousCid`\n  - `comment.postCid`\n  - `comment.parentCid`\n  - `comment.subplebbitAddress`\n  - `comment.shortSubplebbitAddress`\n  - `comment.title`\n  - `comment.content`\n  - `comment.link`\n  - `comment.linkWidth`\n  - `comment.linkHeight`\n  - `comment.thumbnailUrl`\n  - `comment.thumbnailUrlWidth`\n  - `comment.thumbnailUrlHeight`\n  - `comment.flair`\n  - `comment.spoiler`\n  - `comment.depth`\n  - `comment.state`\n  - `comment.updatingState`\n  - `comment.publishingState`  \n  - `(only available after challengeverification event)`\n  - `comment.cid`\n  - `comment.shortCid`\n  - `(only available after first update event)`\n  - `comment.edit`\n  - `comment.original`\n  - `comment.upvoteCount`\n  - `comment.downvoteCount`\n  - `comment.updatedAt`\n  - `comment.pinned`\n  - `comment.deleted`\n  - `comment.removed`\n  - `comment.locked`\n  - `comment.reason`\n  - `comment.replies`\n  - `comment.replyCount`\n- [Comment Events](#comment-events)\n  - [`update`](#update)\n  - [`challenge`](#challenge)\n  - [`challengeverification`](#challengeverification)\n  - `challengerequest`\n  - `challengeanswer`\n  - `error`\n  - [`statechange`](#statechange-1)\n  - [`updatingstatechange`](#updatingstatechange-1)\n  - [`publishingstatechange`](#publishingstatechange)\n- [Pages API](#pages-api)\n  - [`pages.getPage(pageCid)`](#pagesgetpagepagecid)\n  - `pages.pages`\n  - `pages.pageCids`\n- Client API\n  - `client.state`\n  - `client.settings`\n  - `client.setSettings(plebbitRpcSettings)`\n  - `client.rpcCall(method, params)`\n  - `client.getPeers()`\n  - `client.getStats()`\n- [Client Events](#client-events)\n  - [`statechange`](#statechange-2)\n  - [`settingschange`](#settingschange)\n\n## Plebbit API\nThe plebbit API for reading and writing to and from subplebbits.\n\n### `Plebbit(plebbitOptions)`\n\n\u003e Create a plebbit instance.\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| plebbitOptions | `PlebbitOptions` | Options for the plebbit instance |\n\n##### PlebbitOptions\n\nAn object which may have the following keys:\n\n| Name | Type | Default | Description |\n| ---- | ---- | ------- | ----------- |\n| ipfsGatewayUrls | `strings[]` or `undefined` | `['https://cloudflare-ipfs.com']` | Optional URLs of IPFS gateways |\n| kuboRpcClientsOptions | `(string \\| kuboRpcClientsOptions)[]` or `undefined` | `undefined` | Optional URLs of Kubo IPFS APIs or [kuboRpcClientsOptions](https://www.npmjs.com/package/kubo-rpc-client#options), `'http://localhost:5001/api/v0'` to use a local Kubo IPFS node |\n| pubsubKuboRpcClientsOptions | `(string \\| kuboRpcClientsOptions)[]` or `undefined` | `['https://pubsubprovider.xyz/api/v0']` | Optional URLs or [kuboRpcClientsOptions](https://www.npmjs.com/package/kubo-rpc-client#options) used for pubsub publishing when `kuboRpcClientsOptions` isn't available, like in the browser |\n| plebbitRpcClientsOptions | `string[]` or `undefined` | `undefined` | Optional websocket URLs of plebbit RPC servers, required to run a sub from a browser/electron/webview |\n| dataPath | `string`  or `undefined` | .plebbit folder in the current working directory | (Node only) Optional folder path to create/resume the user and subplebbit databases |\n| chainProviders | `{[chainTicker: string]: ChainProvider}` or `undefined` | default providers for supported chains | Optional provider RPC URLs and chain IDs |\n| resolveAuthorAddresses | `boolean`  or `undefined` | `true` | Optionally disable resolving crypto domain author addresses, which can be done lazily later to save time |\n\n##### ChainProvider\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| urls | `string[]` | URLs of the provider RPCs |\n| chainId | `number` | ID of the EVM chain if any |\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cPlebbit\u003e` | A `Plebbit` instance |\n\n#### Example\n\n```js\nconst Plebbit = require('@plebbit/plebbit-js')\nconst options = {\n  ipfsGatewayUrls: ['https://cloudflare-ipfs.com'],\n  kuboRpcClientsOptions: ['http://localhost:5001/api/v0'], // optional, must run an IPFS node to use localhost:5001/api/v0\n  dataPath: __dirname\n}\nconst plebbit = await Plebbit(options) // should be independent instance, not singleton\nplebbit.on('error', console.log)\n```\n\n### `plebbit.getMultisub(multisubAddress)`\n\n\u003e Get a multisub by its `Address`. A multisub is a list of subplebbits curated by the creator of the multisub. E.g. `'plebbit.eth/#/m/john.eth'` would display a feed of the multisub subplebbits curated by `'john.eth'` (multisub `Address` `'john.eth'`).\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| multisubAddress | `string` | The `Address` of the multisub |\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cMultisub\u003e` | A `Multisub` instance. |\n\n#### Example\n\n```js\nconst multisubAddress = '12D3KooW...' // or 'john.eth'\nconst multisub = await plebbit.getSubplebbit(multisubAddress)\nconst multisubSubplebbitAddresses = multisub.map(subplebbit =\u003e subplebbit.address)\nconsole.log(multisubSubplebbitAddresses)\n```\n\n### `plebbit.getSubplebbit(subplebbitAddress)`\n\n\u003e Get a subplebbit by its `Address`.\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| subplebbitAddress | `string` | The `Address` of the subplebbit |\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cSubplebbit\u003e` | A `Subplebbit` instance. |\n\n#### Example\n\n```js\nconst subplebbitAddress = '12D3KooW...'\nconst subplebbit = await plebbit.getSubplebbit(subplebbitAddress)\nconsole.log(subplebbit)\n\nlet currentPostCid = subplebbit.lastPostCid\nconst scrollAllSubplebbitPosts = async () =\u003e {\n  while (currentPostCid) {\n    const post = await plebbit.getComment(currentPostCid)\n    console.log(post)\n    currentPostCid = post.previousCid\n  }\n  console.log('there are no more posts')\n}\nscrollAllSubplebbitPosts()\n/*\nPrints:\n{ ...TODO }\n*/\n```\n\n### `plebbit.getComment(commentCid)`\n\n\u003e Get a plebbit comment by its IPFS CID. Posts are also comments.\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| commentCid | `string` | The IPFS CID of the comment |\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cComment\u003e` | A `Comment` instance |\n\n#### Example\n\n```js\nconst commentCid = 'Qm...'\nconst comment = await plebbit.getComment(commentCid)\nconsole.log('comment:', comment)\ncomment.on('update', updatedComment =\u003e console.log('comment with latest data', updatedComment))\nif (comment.parentCid) { // comment with no parent cid is a post\n  plebbit.getComment(comment.parentCid).then(parentPost =\u003e console.log('parent post:', parentPost))\n}\nplebbit.getSubplebbit(comment.subplebbitAddress).then(subplebbit =\u003e console.log('subplebbit:', subplebbit))\nplebbit.getComment(comment.previousCid).then(previousComment =\u003e console.log('previous comment:', previousComment))\n/*\nPrints:\n{ ...TODO }\n*/\n```\n\n### `plebbit.createMultisub(createMultisubOptions)`\n\n\u003e Create a multisub instance. A multisub is a list of subplebbits curated by the creator of the multisub. E.g. `'plebbit.eth/#/m/john.eth'` would display a feed of the multisub subplebbits curated by `'john.eth'` (multisub `Address` `'john.eth'`).\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| createMultisubOptions | `CreateMultisubOptions` | Options for the `Multisub` instance |\n\n##### CreateMultisubOptions\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| address | `string` or `undefined` | `Address` of the multisub |\n| signer | `Signer` or `undefined` | (Multisub owners only) Optional `Signer` of the subplebbit to create a multisub with a specific private key |\n| title | `string` or `undefined` | Title of the multisub |\n| description | `string` or `undefined` | Description of the multisub |\n| subplebbits | `MultisubSubplebbit[]` or `undefined` | List of `MultisubSubplebbit` of the multisub |\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cMultisub\u003e` | A `Multisub` instance |\n\n#### Example\n\n```js\nconst multisubOptions = {signer}\nconst multisub = await plebbit.createMultisub(multisubOptions)\n\n// edit the multisub info in the database (only in Node and if multisub.signer is defined)\nawait multisub.edit({\n  address: 'funny-subs.eth',\n  title: 'Funny subplebbits',\n  description: 'The funniest subplebbits',\n})\n\n// add a list of subplebbits to the multisub in the database (only in Node and if multisub.signer is defined)\nconst multisubSubplebbit1 = {address: 'funny.eth', title: 'Funny things', tags: ['funny']}\nconst multisubSubplebbit2 = {address: 'even-more-funny.eth'}\nawait multisub.edit({subplebbits: [multisubSubplebbit1, multisubSubplebbit2]})\n\n// start publishing updates to your multisub (only in Node and if multisub.signer is defined)\nawait multisub.start()\n\n// stop publishing updates to your multisub\nawait multisub.stop()\n```\n\n### `plebbit.createSubplebbit(createSubplebbitOptions)`\n\n\u003e Create a subplebbit instance. Should update itself on update events after `Subplebbit.update()` is called if `CreateSubplebbitOptions.address` exists. If the subplebbit database corresponding to `subplebbit.address` exists locally, can call `Subplebbit.edit(subplebbitEditOptions)` to edit the subplebbit as the owner, and `Subplebbit.start()` to listen for new posts on the pubsub and publish updates as the owner.\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| createSubplebbitOptions | `CreateSubplebbitOptions` | Options for the `Subplebbit` instance |\n\n##### CreateSubplebbitOptions\n\nAn object which may have the following keys:\n\n| Name | Type | Default | Description |\n| ---- | ---- | ------- | ----------- |\n| address | `string` or `undefined` | `undefined` | `Address` of the subplebbit |\n| signer | `Signer` or `undefined` | `undefined` | (Subplebbit owners only) Optional `Signer` of the subplebbit to create a subplebbit with a specific private key |\n| ...subplebbit | `any` | `undefined` | `CreateSubplebbitOptions` can also initialize any property on the `Subplebbit` instance |\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cSubplebbit\u003e` | A `Subplebbit` instance |\n\n#### Example\n\n```js\nconst Plebbit = require('@plebbit/plebbit-js')\nconst plebbitOptions = {\n  ipfsGatewayUrls: ['https://cloudflare-ipfs.com'],\n  kuboRpcClientsOptions: ['http://localhost:5001/api/v0'], // optional, must run an IPFS node to use localhost:5001/api/v0\n  dataPath: __dirname\n}\nconst plebbit = await Plebbit(plebbitOptions)\nplebbit.on('error', console.log)\n\n// create a new local subplebbit as the owner\nconst subplebbit = await plebbit.createSubplebbit()\n\n// create a new local subplebbit as the owner, already with settings\nconst subplebbit = await plebbit.createSubplebbit({title: 'Memes', description: 'Post your memes here.'})\n\n// create a new local subplebbit as the owner with a premade signer\nconst signer = await plebbit.createSigner()\nconst subplebbit = await plebbit.createSubplebbit({signer})\n// signer.address === subplebbit.address\n\n// create a new local subplebbit as the owner with a premade signer, already with settings\nconst signer = await plebbit.createSigner()\nconst subplebbit = await plebbit.createSubplebbit({signer, title: 'Memes', description: 'Post your memes here.'})\n\n// instantiate an already existing subplebbit instance\nconst subplebbitOptions = {address: '12D3KooW...',}\nconst subplebbit = await plebbit.createSubplebbit(subplebbitOptions)\n\n// edit the subplebbit info in the database\nawait subplebbit.edit({\n  title: 'Memes',\n  description: 'Post your memes here.',\n  pubsubTopic: '12D3KooW...'\n})\n\n// start publishing updates every 5 minutes\nawait subplebbit.start()\n\n// instantiate an already existing subplebbit instance and initialize any property on it\nconst subplebbit = await plebbit.createSubplebbit({\n  address: '12D3KooW...',\n  title: 'Memes',\n  posts: {\n    pages: {\n      hot: {\n        nextCid: 'Qm...', \n        comments: [{content: 'My first post', ...post}]\n      }\n    },\n    pageCids: {topAll: 'Qm...', new: 'Qm...', ...pageCids}\n  }\n})\nconsole.log(subplebbit.title) // prints 'Memes'\nconsole.log(subplebbit.posts.pages.hot.comments[0].content) // prints 'My first post'\n```\n\n### `plebbit.createSubplebbitEdit(createSubplebbitEditOptions)`\n\n\u003e Create a `SubplebbitEdit` instance, which can be used by admins to edit a subplebbit remotely over pubsub. A `SubplebbitEdit` is a regular `Publication` and must still be published and go through a challenge handshake.\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| createSubplebbitEditOptions | `CreateSubplebbitEditOptions` | The subplebbit edit to create, extends [`SubplebbitEditOptions`](#subplebbiteditoptions) |\n\n##### CreateSubplebbitEditOptions\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| address | `string` | `Address` of the subplebbit to edit |\n| timestamp | `number` or `undefined` | Time of publishing in seconds, `Math.round(Date.now() / 1000)` if undefined |\n| author | `Author` | `author.address` of the subplebbit edit must have `subplebbit.roles` `'admin'` |\n| signer | `Signer` | Signer of the subplebbit edit |\n| ...subplebbitEditOptions | `any` | `CreateSubplebbitEditOptions` extends [`SubplebbitEditOptions`](#subplebbiteditoptions) |\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cSubplebbitEdit\u003e` | A `SubplebbitEdit` instance |\n\n#### Example\n\n```js\nconst createSubplebbitEditOptions = {address: 'news.eth', title: 'New title'}\nconst subplebbitEdit = await plebbit.createSubplebbitEdit(createSubplebbitEditOptions)\nsubplebbitEdit.on('challenge', async (challengeMessage, _subplebbitEdit) =\u003e {\n  const challengeAnswers = await askUserForChallengeAnswers(challengeMessage.challenges)\n  _subplebbitEdit.publishChallengeAnswers(challengeAnswers)\n})\nsubplebbitEdit.on('challengeverification', console.log)\nawait subplebbitEdit.publish()\n```\n\n### `plebbit.createComment(createCommentOptions)`\n\n\u003e Create a `Comment` instance. Posts/Replies are also comments. Should update itself on update events after `Comment.update()` is called if `CreateCommentOptions.cid` exists.\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| createCommentOptions | `CreateCommentOptions` | The comment to create |\n\n##### CreateCommentOptions\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| subplebbitAddress | `string` | `Address` of the subplebbit |\n| timestamp | `number` or `undefined` | Time of publishing in seconds, `Math.round(Date.now() / 1000)` if undefined |\n| author | `Author` | Author of the comment |\n| signer | `Signer` | Signer of the comment |\n| parentCid | `string` or `undefined` | The parent comment CID, undefined if comment is a post, same as postCid if comment is top level |\n| content | `string` or `undefined` | Content of the comment, link posts have no content |\n| title | `string` or `undefined` | If comment is a post, it needs a title |\n| link | `string` or `undefined` | If comment is a post, it might be a link post |\n| spoiler | `boolean` or `undefined` | Hide the comment thumbnail behind spoiler warning |\n| flair | `Flair` or `undefined` | Author or mod chosen colored label for the comment |\n| challengeRequest | `ChallengeRequest` or `undefined` | Optional properties to pass to `ChallengeRequestPubsubMessage` |\n| cid | `string` or `undefined` | (Not for publishing) Gives access to `Comment.on('update')` for a comment already fetched |\n| ...comment | `any` | `CreateCommentOptions` can also initialize any property on the `Comment` instance |\n\n##### ChallengeRequest\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| challengeAnswers | `string[]` or `undefined` | Optional pre-answers to subplebbit.challenges |\n| challengeCommentCids | `string[]` or `undefined` | Optional comment cids for subplebbit.challenges related to author karma/age in other subs |\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cComment\u003e` | A `Comment` instance |\n\n#### Example\n\n```js\nconst comment = await plebbit.createComment(createCommentOptions)\ncomment.on('challenge', async (challengeMessage) =\u003e {\n  const challengeAnswers = await askUserForChallengeAnswers(challengeMessage.challenges)\n  comment.publishChallengeAnswers(challengeAnswers)\n})\ncomment.on('challengeverification', console.log)\nawait comment.publish()\n\n// initialize any property on the Comment instance\nconst comment = await plebbit.createComment({\n  cid: 'Qm...',\n  content: 'My first post',\n  locked: true,\n  upvoteCount: 100,\n  replies: {\n    pages: {\n      topAll: {\n        nextCid: 'Qm...', \n        comments: [{content: 'My first reply', ...reply}]\n      }\n    },\n    pageCids: {new: 'Qm...', old: 'Qm...', ...pageCids}\n  }\n})\nconsole.log(comment.content) // prints 'My first post'\nconsole.log(comment.locked) // prints true\nconsole.log(comment.upvoteCount) // prints 100\nconsole.log(comment.replies.pages.topAll.comments[0].content) // prints 'My first reply'\n```\n\n### `plebbit.createCommentEdit(createCommentEditOptions)`\n\n\u003e Create a `CommentEdit` instance, which can be used by authors to edit their own comments. A `CommentEdit` must still be published and go through a challenge handshake.\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| createCommentEditOptions | `CreateCommentEditOptions` | The comment edit to create |\n\n##### CreateCommentEditOptions\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| subplebbitAddress | `string` | `Address` of the subplebbit |\n| commentCid | `string` | The comment CID to be edited (don't use 'cid' because eventually CommentEdit.cid will exist) |\n| timestamp | `number` or `undefined` | Time of publishing in ms, `Math.round(Date.now() / 1000)` if undefined |\n| author | `Author` | Author of the `CommentEdit` publication, must be original author. Not used to edit the `comment.author` property, only to authenticate the `CommentEdit` publication |\n| signer | `Signer` | Signer of the edit, must be original author |\n| content | `string` or `undefined` | Edited content of the comment |\n| deleted | `boolean` or `undefined` | Edited deleted status of the comment |\n| flair | `Flair` or `undefined` | Edited flair of the comment |\n| spoiler | `boolean` or `undefined` | Edited spoiler of the comment |\n| reason | `string` or `undefined` | Reason of the edit |\n| challengeRequest | `ChallengeRequest` or `undefined` | Optional properties to pass to `ChallengeRequestPubsubMessage` |\n\n##### ChallengeRequest\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| challengeAnswers | `string[]` or `undefined` | Optional pre-answers to subplebbit.challenges |\n| challengeCommentCids | `string[]` or `undefined` | Optional comment cids for subplebbit.challenges related to author karma/age in other subs |\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cCommentEdit\u003e` | A `CommentEdit` instance |\n\n#### Example\n\n```js\nconst commentEdit = await plebbit.createCommentEdit(createCommentEditOptions)\ncommentEdit.on('challenge', async (challengeMessage, _commentEdit) =\u003e {\n  const challengeAnswers = await askUserForChallengeAnswers(challengeMessage.challenges)\n  _commentEdit.publishChallengeAnswers(challengeAnswers)\n})\ncommentEdit.on('challengeverification', console.log)\nawait commentEdit.publish()\n```\n\n### `plebbit.createCommentModeration(createCommentModerationOptions)`\n\n\u003e Create a `CommentModeration` instance, which can be used by moderators to remove comments. A `CommentModeration` must still be published and go through a challenge handshake.\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| createCommentModerationOptions | `CreateCommentModerationOptions` | The comment moderation to create |\n\n##### CreateCommentModerationOptions\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| subplebbitAddress | `string` | `Address` of the subplebbit |\n| commentCid | `string` | The comment CID to be edited (don't use 'cid' because eventually CommentEdit.cid will exist) |\n| timestamp | `number` or `undefined` | Time of publishing in ms, `Math.round(Date.now() / 1000)` if undefined |\n| author | `Author` | Author of the `CommentModeration` publication, must be moderator. Not used to edit the `comment.author` property, only to authenticate the `CommentModeration` publication |\n| signer | `Signer` | Signer of the edit, must be moderator |\n| commentModeration | `CommentModerationOptions` | The comment moderation options |\n| challengeRequest | `ChallengeRequest` or `undefined` | Optional properties to pass to `ChallengeRequestPubsubMessage` |\n\n##### CommentModerationOptions\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| flair | `Flair` or `undefined` | Edited flair of the comment |\n| spoiler | `boolean` or `undefined` | Edited spoiler of the comment |\n| reason | `string` or `undefined` | Reason of the edit |\n| pinned | `boolean` or `undefined` | Edited pinned status of the comment |\n| locked | `boolean` or `undefined` |Edited locked status of the comment |\n| removed | `boolean` or `undefined` | Edited removed status of the comment |\n| author | `CommentModerationAuthorOptions` or `undefined` | Edited author property of the comment |\n\n##### CommentModerationAuthorOptions\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| banExpiresAt | `number` or `undefined` | Comment author was banned for this comment |\n| flair | `Flair` or `undefined` | Edited flair of the comment author |\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cCommentModeration\u003e` | A `CommentModeration` instance |\n\n#### Example\n\n```js\nconst commentModeration = await plebbit.createCommentModeration(createCommentModerationOptions)\ncommentModeration.on('challenge', async (challengeMessage, _commentModeration) =\u003e {\n  const challengeAnswers = await askUserForChallengeAnswers(challengeMessage.challenges)\n  _commentModeration.publishChallengeAnswers(challengeAnswers)\n})\ncommentModeration.on('challengeverification', console.log)\nawait commentModeration.publish()\n```\n\n### `plebbit.createVote(createVoteOptions)`\n\n\u003e Create a `Vote` instance. `Vote` inherits from `Publication`, like `Comment`, so has the same API.\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| createVoteOptions | `CreateVoteOptions` | The vote to create |\n\n##### CreateVoteOptions\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| subplebbitAddress | `string` | `Address` of the subplebbit |\n| commentCid | `string` | The comment or post to vote on |\n| timestamp | `number` or `undefined` | Time of publishing in ms, `Math.round(Date.now() / 1000)` if undefined |\n| author | `Author` | Author of the comment, will be needed for voting with NFTs or tokens |\n| vote | `1` or `0` or `-1` | 0 is for resetting a vote |\n| signer | `Signer` | Signer of the vote |\n| challengeRequest | `ChallengeRequest` or `undefined` | Optional properties to pass to `ChallengeRequestPubsubMessage` |\n\n##### ChallengeRequest\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| challengeAnswers | `string[]` or `undefined` | Optional pre-answers to subplebbit.challenges |\n| challengeCommentCids | `string[]` or `undefined` | Optional comment cids for subplebbit.challenges related to author karma/age in other subs |\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cVote\u003e` | A `Vote` instance |\n\n#### Example\n\n```js\nconst vote = await plebbit.createVote(createVoteOptions)\nvote.on('challenge', async (challengeMessage, _vote) =\u003e {\n  const challengeAnswers = await askUserForChallengeAnswers(challengeMessage.challenges)\n  _vote.publishChallengeAnswers(challengeAnswers)\n})\nvote.on('challengeverification', console.log)\nawait vote.publish()\n```\n\n### `plebbit.createSigner(createSignerOptions)`\n\n\u003e Create a `Signer` instance to be used in `CreateCommentOptions`.\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| createSignerOptions | `CreateSignerOptions` or `undefined` | The options of the signer |\n\n##### CreateSignerOptions\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| privateKey | `string` or `undefined` | If undefined, generate a random `privateKey` |\n| type | `string` | Required if `privateKey` defined, only `'ed25519'` for now |\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cSigner\u003e` | A `Signer` instance |\n\n#### Example\n\n```js\nconst newRandomSigner = await plebbit.createSigner()\nconst signerFromPrivateKey = await plebbit.createSigner({privateKey: 'AbCd...', type: 'ed25519'})\n```\n\n### `plebbit.listSubplebbits()`\n\n\u003e (Only for Node or over RPC) Get all the subplebbit addresses in the `${plebbit.dataPath}/subplebbits` folder. Same as doing `ls ${plebbit.dataPath}/subplebbits`.\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cAddress[]\u003e` | An array of `Address` strings |\n\n#### Example\n\n```js\n// start all the subplebbits you own and have stored locally\nconst subplebbitAddresses = await plebbit.listSubplebbits()\nfor (const address of subplebbitAddresses) {\n  const subplebbit = await plebbit.createSubplebbit({address})\n  await subplebbit.start()\n}\n```\n\n### `plebbit.getDefaults()`\n\n\u003e Get the default global plebbit settings, e.g. the default multisubs like p/all, p/dao, etc.\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cPlebbitDefaults\u003e` | A `PlebbitDefaults` instance. |\n\n#### Example\n\n```js\nconst plebbitDefaults = await plebbit.getDefaults()\nconst allMultisub = await plebbit.getMultisub(plebbitDefaults.multisubAddresses.all)\nconst allSubplebbitAddresses = allMultisub.map(subplebbit =\u003e subplebbit.address)\nconsole.log(allSubplebbitAddresses)\n```\n\n## Plebbit Events\nThe plebbit events.\n\n### `subplebbitschange`\n\n\u003e `Plebbit.subplebbits` property changed.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `string[]` | The `Subplebbit.subplebbits` property |\n\n## Subplebbit API\nThe subplebbit API for getting subplebbit updates, or creating, editing, running a subplebbit as an owner.\n\n### `subplebbit.edit(subplebbitEditOptions)`\n\n\u003e Edit the content/information of a subplebbit in your local database. Only usable if the subplebbit database corresponding to `subplebbit.address` exists locally  (ie. you are the subplebbit owner).\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| subplebbit | `SubplebbitEditOptions` | The content/information of the subplebbit |\n\n##### SubplebbitEditOptions\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| address | `string` or `undefined` | Address of the subplebbit, used to add a crypto domain |\n| signer | `Signer` or `undefined` | Signer of the subplebbit, useful to change the private if the owner gets hacked, but still has his crypto domain\n| title | `string` or `undefined` | Title of the subplebbit |\n| description | `string` or `undefined` | Description of the subplebbit |\n| roles | `{[authorAddress: string]: SubplebbitRole}` or `undefined` | Author addresses of the moderators |\n| lastPostCid | `string` or `undefined` | The most recent post in the linked list of posts |\n| posts | `Pages` or `undefined` | Only preload page 1 sorted by 'hot', might preload more later, should include some child comments and vote counts for each post |\n| pubsubTopic | `string` or `undefined` | The string to publish to in the pubsub, a public key of the subplebbit owner's choice |\n| features | `SubplebbitFeatures` or `undefined` | The features of the subplebbit |\n| suggested | `SubplebbitSuggested` or `undefined` | The suggested client settings for the subplebbit |\n| flairs | `{[key: 'post' or 'author']: Flair[]}` or `undefined` | The list of flairs (colored labels for comments or authors) authors or mods can choose from |\n| settings | `SubplebbitSettings` or `undefined` | The private subplebbit.settings property of the subplebbit, not shared in the subplebbit IPNS |\n\n##### SubplebbitSettings\n\nAn object which may have the following keys:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| fetchThumbnailUrls | `boolean` or `undefined` | Fetch the thumbnail URLs of comments `comment.link` property, could reveal the IP address of the subplebbit node |\n| fetchThumbnailUrlsProxyUrl | `string` or `undefined` | The HTTP proxy URL used to fetch thumbnail URLs |\n\n#### Example\n\n```js\n// TODO\n```\n\n### `subplebbit.start()`\n\n\u003e Start listening for new posts on the pubsub, and publishing them every 5 minutes. Only usable if the subplebbit database corresponding to `subplebbit.address` exists locally  (ie. you are the subplebbit owner).\n\n#### Example\n\n```js\nconst options = {\n  title: 'Your subplebbit title'\n}\nconst subplebbit = await plebbit.createSubplebbit(options)\n// edit the subplebbit info in the database\nawait subplebbit.edit({\n  title: 'Memes',\n  description: 'Post your memes here.',\n  pubsubTopic: '12D3KooW...'\n})\n// start publishing updates/new posts\nawait subplebbit.start()\n```\n\n### `subplebbit.stop()`\n\n\u003e Stop polling the network for new subplebbit updates started by subplebbit.update(). Also stop listening for new posts on the pubsub started by subplebbit.start(), and stop publishing them every 5 minutes.\n\n### `subplebbit.update()`\n\n\u003e Start polling the network for new posts published in the subplebbit, update itself and emit the 'update' event. Only usable if subplebbit.address exists.\n\n#### Example\n\n```js\nconst options = {\n  address: '12D3KooW...'\n}\nconst subplebbit = await plebbit.createSubplebbit(options)\nsubplebbit.on('update', (updatedSubplebbitInstance) =\u003e {\n  console.log(updatedSubplebbitInstance)\n\n  // if you want to stop polling for new updates after only the first one\n  subplebbit.stop()\n})\nsubplebbit.update()\n```\n\n## Subplebbit Events\nThe subplebbit events.\n\n### `update`\n\n\u003e The subplebbit's IPNS record has been updated, which means new posts may have been published.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `Subplebbit` | The updated `Subplebbit` instance (the instance emits itself), i.e. `this` |\n\n#### Example\n\n```js\nconst options = {\n  address: '12D3KooW...'\n}\nconst subplebbit = await plebbit.createSubplebbit(options)\nsubplebbit.on('update', (updatedSubplebbit) =\u003e console.log(updatedSubplebbit))\nsubplebbit.update()\n\n// stop updating in 10 minutes\nsetTimeout(() =\u003e subplebbit.stop(), 60000)\n```\n\n### `challengerequest`\n\n\u003e When the user publishes a comment, he makes a `'challengerequest'` to the pubsub, the subplebbit owner will send back a `challenge`, eg. a captcha that the user must complete.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `ChallengeRequestMessage` | The comment of the user and the challenge request |\n\nObject is of the form:\n\n```js\n{ // ...TODO }\n```\n\n#### Example\n\n```js\n{ // ...TODO }\n```\n\n### `challengeanswer`\n\n\u003e After receiving a `Challenge`, the user owner will send back a `challengeanswer`.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `ChallengeAnswerMessage` | The challenge answer |\n\nObject is of the form:\n\n```js\n{ // ...TODO }\n```\n\n### `challengerequest`\n\n\u003e When the user publishes a comment, he makes a `'challengerequest'` to the pubsub, the subplebbit owner will send back a `challenge`, eg. a captcha that the user must complete.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `ChallengeRequestMessage` | The comment of the user and the challenge request |\n\nObject is of the form:\n\n```js\n{ // ...TODO }\n```\n\n#### Example\n\n```js\n{ // ...TODO }\n```\n\n### `statechange`\n\n\u003e `Subplebbit.state` property changed.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `'stopped' \\| 'updating' \\| 'started'` | The `Subplebbit.state` property |\n\n### `updatingstatechange`\n\n\u003e `Subplebbit.updatingState` property changed.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `'stopped' \\| 'resolving-address' \\| 'fetching-ipns' \\| 'fetching-ipfs' \\| 'failed' \\| 'succeeded'` | The `Subplebbit.updatingState` property |\n\n### `startedstatechange`\n\n\u003e `Subplebbit.startedState` property changed.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `'stopped' \\| 'fetching-ipns' \\| 'publishing-ipns' \\| 'failed' \\| 'succeeded'` | The `Subplebbit.startedState` property |\n\n## Comment API\nThe comment API for publishing a comment as an author, or getting comment updates. `Comment`, `Vote` and `CommentEdit` inherit `Publication` class and all have a similar API. A `Comment` updates itselfs on update events after `Comment.update()` is called if `Comment.cid` exists.\n\n### `comment.publish()`\n\n\u003e Publish the comment to the pubsub. You must then wait for the `'challenge'` event and answer with a `ChallengeAnswer`.\n\n#### Example\n\n```js\nconst comment = await plebbit.createComment(commentObject)\ncomment.on('challenge', async (challengeMessage) =\u003e {\n  const challengeAnswers = await askUserForChallengeAnswers(challengeMessage.challenges)\n  comment.publishChallengeAnswers(challengeAnswers)\n})\ncomment.on('challengeverification', console.log)\nawait comment.publish()\n```\n\n### `comment.publishChallengeAnswers(challengeAnswers)`\n\n\u003e Publish your answers to the challenges e.g. the captcha answers.\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| challengeAnswers | `string[]` | The challenge answers |\n\n#### Example\n\n```js\nconst comment = await plebbit.createComment(commentObject)\ncomment.on('challenge', async (challengeMessage) =\u003e {\n  const challengeAnswers = await askUserForChallengeAnswers(challengeMessage.challenges)\n  comment.publishChallengeAnswers(challengeAnswers)\n})\ncomment.on('challengeverification', console.log)\nawait comment.publish()\n```\n\n### `comment.update()`\n\n\u003e Start polling the network for comment updates (replies, upvotes, edits, etc), update itself and emit the update event. Only usable if comment.cid or exists.\n\n#### Example\n\n```js\nconst commentCid = 'Qm...'\nconst comment = await plebbit.getComment(commentCid)\ncomment.on('update', (updatedCommentInstance) =\u003e {\n  console.log(updatedCommentInstance)\n\n  // if you want to stop polling for new updates after only the first one\n  comment.stop()\n})\ncomment.update()\n\n// if you already fetched the comment and only want the updates\nconst commentDataFetchedEarlier = {content, author, cid, ...comment}\nconst comment = await plebbit.createComment(commentDataFetchedEarlier)\ncomment.on('update', () =\u003e {\n  console.log('the comment instance updated itself:', comment)\n})\ncomment.update()\n```\n\n### `comment.stop()`\n\n\u003e Stop polling the network for new comment updates started by comment.update().\n\n## Comment Events\nThe comment events.\n\n### `update`\n\n\u003e The comment has been updated, which means vote counts and replies may have changed. To start polling the network for updates, call `Comment.update()`. If the previous `CommentUpdate` is the same, do not emit `update`.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `Comment` | The updated `Comment`, i.e. itself, `this` |\n\nObject is of the form:\n\n```js\n{ // ...TODO }\n```\n\n#### Example\n\n```js\nconst comment = await plebbit.getComment(commentCid)\ncomment.on('update', (updatedComment) =\u003e {\n  console.log(updatedComment)\n})\ncomment.update()\n\n// stop looking for updates after 10 minutes\nsetTimeout(() =\u003e comment.stop(), 60000)\n```\n\n### `challenge`\n\n\u003e After publishing a comment, the subplebbit owner will send back a `challenge`, eg. a captcha that the user must complete.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `ChallengeMessage` | The challenge the user must complete |\n| `Comment` | The `Comment` instance, i.e. `this` |\n\nObject is of the form:\n\n```js\n{ // ...TODO }\n```\n\n#### Example\n\n```js\nconst comment = await plebbit.createComment(commentObject)\ncomment.on('challenge', async (challengeMessage, _comment) =\u003e {\n  const challengeAnswers = await askUserForChallengeAnswers(challengeMessage.challenges)\n  _comment.publishChallengeAnswers(challengeAnswers)\n})\ncomment.on('challengeverification', console.log)\nawait comment.publish()\n```\n\n### `challengeverification`\n\n\u003e After publishing a challenge answer, the subplebbit owner will send back a `challengeverification` to let the network know if the challenge was completed successfully.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `ChallengeVerificationMessage` | The challenge verification result |\n| `Comment` | The `Comment` instance, i.e. `this` |\n\nObject is of the form:\n\n```js\n{ // ...TODO }\n```\n\n#### Example\n\n```js\nconst comment = await plebbit.createComment(commentObject)\ncomment.on('challenge', async (challengeMessage) =\u003e {\n  const challengeAnswers = await askUserForChallengeAnswers(challengeMessage.challenges)\n  comment.publishChallengeAnswers(challengeAnswers)\n})\ncomment.on('challengeverification', (challengeVerification) =\u003e console.log('published post cid is', challengeVerification?.publication?.cid))\nawait comment.publish()\n```\n\n### `statechange`\n\n\u003e `Comment.state` property changed.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `'stopped' \\| 'updating' \\| 'publishing'` | The `Comment.state` property |\n\n### `updatingstatechange`\n\n\u003e `Comment.updatingState` property changed.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `'stopped' \\| 'resolving-author-address' \\| 'fetching-ipfs' \\| 'fetching-update-ipns' \\| 'fetching-update-ipfs' \\| 'failed' \\| 'succeeded'` | The `Comment.updatingState` property |\n\n### `publishingstatechange`\n\n\u003e `Comment.publishingState` property changed.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `'stopped' \\| 'resolving-subplebbit-address' \\| 'fetching-subplebbit-ipns' \\| 'fetching-subplebbit-ipfs' \\| 'publishing-challenge-request' \\| 'waiting-challenge' \\| 'waiting-challenge-answers' \\| 'publishing-challenge-answer' \\| 'waiting-challenge-verification' \\| 'failed' \\| 'succeeded'` | The `Comment.publishingState` property |\n\n## Pages API\nThe pages API for scrolling pages of a subplebbit or replies to a post/comment. `Subplebbit.posts` and `Comment.replies` are `Pages` instances. `Subplebbit.posts.pages.hot` is a `Page` instance.\n\n### `pages.getPage(pageCid)`\n\n\u003e Get a `Page` instance using an IPFS CID from `Pages.pageCids[sortType]`, e.g. `Subplebbit.posts.pageCids.hot` or `Comment.replies.pageCids.topAll`.\n\n#### Parameters\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| pageCid | `string` | The IPFS CID of the page |\n\n#### Returns\n\n| Type | Description |\n| -------- | -------- |\n| `Promise\u003cPage\u003e` | A `Page` instance |\n\n#### Example\n\n```js\n// get sorted posts in a subplebbit\nconst subplebbit = await plebbit.getSubplebbit(subplebbitAddress)\nconst pageSortedByTopYear = await subplebbit.posts.getPage(subplebbit.posts.pageCids.topYear)\nconst postsSortedByTopYear = pageSortedByTopYear.comments\nconsole.log(postsSortedByTopYear)\n\n// get sorted replies to a post or comment\nconst post = await plebbit.getComment(commentCid)\npost.on('update', async updatedPost =\u003e {\n  let replies\n  // try to get sorted replies by sort type 'new'\n  // sorted replies pages are not always available, for example if the post only has a few replies\n  if (updatedPost.replies?.pageCids?.new) {\n    const repliesPageSortedByNew = await updatedPost.replies.getPage(updatedPost.replies.pageCids.new)\n    replies = repliesPageSortedByNew.comments\n  }\n  else {\n    // the 'topAll' sort type is always preloaded by default on replies and can be used as fallback\n    // on subplebbits.posts only 'hot' is preloaded by default\n    replies = updatedPost.replies.pages.topAll.comments\n  }\n  console.log(replies)\n})\n```\n\n## Client Events\nThe client events.\n\n### `statechange`\n\n\u003e `Client.state` property changed.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `'stopped' \\| 'resolving-author-address' \\| 'fetching-ipfs' \\| 'fetching-update-ipns' \\| 'fetching-update-ipfs' \\| 'resolving-subplebbit-address' \\| 'fetching-subplebbit-ipns' \\| 'fetching-subplebbit-ipfs' \\| 'subscribing-pubsub' \\| 'publishing-challenge-request' \\| 'waiting-challenge' \\| 'waiting-challenge-answers' \\| 'publishing-challenge-answer' \\| 'waiting-challenge-verification' \\| 'connecting' \\| 'connected'` | The `Client.state` property |\n\n#### Example\n\n```js\nconst onStateChange = (state) =\u003e console.log('client state changed:', state)\nfor (const clientUrl in clients?.ipfsGateways) {\n  comment.clients?.ipfsGateways?.[clientUrl].on('statechange', onStateChange)\n}\nfor (const clientUrl in clients?.ipfsClients) {\n  comment.clients?.ipfsClients?.[clientUrl].on('statechange', onStateChange)\n}\nfor (const clientUrl in clients?.pubsubClients) {\n  comment.clients?.pubsubClients?.[clientUrl].on('statechange', onStateChange)\n}\nfor (const chainTicker in clients?.chainProviders) {\n  for (const clientUrl in clients?.chainProviders?.[chainTicker]) {\n    comment.clients?.chainProviders?.[chainTicker]?.[clientUrl].on('statechange', onStateChange)\n  }\n}\n```\n\n### `settingschange`\n\n\u003e `Client.settings` property changed.\n\n#### Emits\n\n| Type | Description |\n| -------- | -------- |\n| `PlebbitRpcSettings` | The `Client.settings` property |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplebbit%2Fplebbit-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplebbit%2Fplebbit-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplebbit%2Fplebbit-js/lists"}