b0VIM 8.0FXaI ]celideology~cel/src/ssb-issues/README.mdutf-8 3210#"! UtpMad tsmkZH6&$  r$h b ` 6 )      ~ x ` \ [ 1 0 * (   r R  w H  D @ ?  /LK;:'& oBA/.(}|S  RQ65/o"```js#### getMention: sync closed (false), or does not affect it (null)-```js#### getMention: sync closed (false), or does not affect it (null)- `open` (boolean?): whether the message updates the issue to be open (true)- `issue` (Issue): issue to check for update- `msg` (Msg in metadata): message to checkCheck if a message changes an issue's status```var open = issueSchemas.isStatusChanged(issue, msg)```js#### isStatusChanged: sync`opts.title` (string): set title (deprecated)`opts.open` (boolean): set open/closed status`id` (MsgRef): id of the issue to reopenEdit an issue.```issues.edit(id, opts, cb)````js#### edit: async`text` (string): text to accompany the open action`id` (MsgRef): id of the issue to reopenMark an issue as open.```issues.reopen(id, cb)````js#### reopen: async`id` (MsgRef): id of the issue to reopenMark an issue as closed.```issues.close(id, cb)```js#### close: async- `text` (string): text describing the issue- `title` (string): title of the issue (deprecated)- `project` (Ref): id of an ssb object representing the target of the issue```issues.new({ project:, title:, text: }, cb)```jsCreate a new issue#### new: async - `reverse` (boolean, default: `false`): reverse the order of results - `lt` (less than), `lte` (less than or equal): minimum `[timestamp, id]` - `gt` (greater than), `gte` (greater than or equal): maximum `[timestamp, id]` - `live` (boolean, default: `false`): Keep the stream open and emit new messages as they are received. - `author` (FeedRef): get only issues from the given feed - `open` (boolean): get only open or closed issues - `project` (Ref): get only issues for the given target```issues.list({ project:, open:, author:, live:, gt:, gte:, lt:, lte:, reverse: })```jsGet a stream of issues #### list: source `.key` and `.value`).- `msg`: ssb message object that created the issue (with- `projectAuthor`: the author of the project- `project`: the project that the issue is for- `open`: whether the issue is open (true) or closed (false)- `title`: title of the issue (deprecated)- `updated_at` (timestamp): when the issue was last updated- `created_at` (timestamp): when the issue was created- `author`: author of the issue- `id`: id of the issue```} msg: Msg, open: boolean, updated_at: number, created_at: number, projectAuthor: FeedRef?, project: Ref?, author: FeedRef, id: MsgRef,{```jsThe resulting issue object is as follows:```issues.get(issueId, cb)```jsGet an issue by its id#### get: async```var issues = Issues.init(sbot)var Issues = require('ssb-issues')```js## API```} }] open: boolean, link: IssueRef, issues: [{ type: 'issue-make a post that updates an issue, or push a git commit that updates an issue. If the message does not have any content other than to update the issue, then the type should be `issue-edit`.thethe type may be `issue-edit`.If the message does not have any content other than to update the issue, thenmake a post that updates an issue, or push a git commit that updates an issue.Edits to an issue may be done by any ssb message type. For example, you can#### issue edits```} text: string? title: string?, project: Link?, type: 'issue',{```jsAn issue. Represents something that should be fixed.#### type: issue## SchemaIssue tracking built on secure-scuttlebutt# ssb-issuesadTlbC?>.-r[E4(&"!  v K  y _ ^ L K 3 2 , i . u * :  baNMG0,+~onE`_3srl"````js#### getMention: sync closed (false), or does not affect it (null)- ```js#### getMention: sync closed (false), or does not affect it (nul```js#### getMention: sync closed (false), or does not affect it (null)- `open` (boolean?): whether the message updates the issue to be open (true)- `issue` (Issue): issue to check for update- `msg` (Msg in metadata): message to checkCheck if a message changes an issue's status```var open = issueSchemas.isStatusChanged(issue, msg)```js#### isStatusChanged: sync`opts.title` (string): set title (deprecated)`opts.open` (boolean): set open/closed status`id` (MsgRef): id of the issue to reopenEdit an issue.```issues.edit(id, opts, cb)````js#### edit: async`text` (string): text to accompany the open action`id` (MsgRef): id of the issue to reopenMark an issue as open.```issues.reopen(id, cb)````js#### reopen: async`id` (MsgRef): id of the issue to reopenMark an issue as closed.```issues.close(id, cb)```js#### close: async- `text` (string): text describing the issue- `title` (string): title of the issue (deprecated)- `project` (Ref): id of an ssb object representing the target of the issue```issues.new({ project:, title:, text: }, cb)```jsCreate a new issue#### new: async - `reverse` (boolean, default: `false`): reverse the order of results - `lt` (less than), `lte` (less than or equal): minimum `[timestamp, id]` - `gt` (greater than), `gte` (greater than or equal): maximum `[timestamp, id]` - `live` (boolean, default: `false`): Keep the stream open and emit new messages as they are received. - `author` (FeedRef): get only issues from the given feed - `open` (boolean): get only open or closed issues - `project` (Ref): get only issues for the given target```issues.list({ project:, open:, author:, live:, gt:, gte:, lt:, lte:, reverse: })```jsGet a stream of issues #### list: source `.key` and `.value`).- `msg`: ssb message object that created the issue (with- `projectAuthor`: the author of the project- `project`: the project that the issue is for- `open`: whether the issue is open (true) or closed (false)- `title`: title of the issue (deprecated)- `updated_at` (timestamp): when the issue was last updated- `created_at` (timestamp): when the issue was created- `author`: author of the issue- `id`: id of the issue```} msg: Msg, open: boolean, updated_at: number, created_at: number, projectAuthor: FeedRef?, project: Ref?, author: FeedRef, id: MsgRef,{```jsThe resulting issue object is as follows:```issues.get(issueId, cb)```jsGet an issue by its id#### get: async```var issues = Issues.init(sbot)var Issues = require('ssb-issues')```js## API```} }] open: boolean, link: IssueRef, issues: [{ type: 'issue-edit'|'post'|'git-update',{```jsadsMm@~2 h d c 5 4  ~ } Z Y J I  t s T S B A   e d ? >   H  DISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.notified of this instrument.retained with the works, so that any entity that uses the works isUsage of the works is permitted provided that this instrument isCopyright (c) 2016 Charles Lehner## License- `id` (MsgRef): id of an issue to mark as open- `msg` (Msg): message object to updateMutate a message to make it reopen an issue#### `issueSchemas.reopens(msg, id)`- `id` (MsgRef): id of an issue to mark as closed- `msg` (Msg): message object to updateMutate a message to make it close an issue#### `issueSchemas.closes(msg, id)`- `id` (MsgRef): id of an issue to mark as openReopen an issue.#### `issueSchemas.reopen(id)`- `id` (MsgRef): id of an issue to mark as closedClose an issue.#### `issueSchemas.close(id)`- `opts.title` (string): set the title of the issue (deprecated)- `opts.open` (boolean): open or close the issueEdit an issue.#### `issueSchemas.edit(id, opts)`- `text` (string): text body for the issue- `title` (string): title to give the issue (deprecated)- `project` (Ref): id of project to associate the issue withCreate a new issue.#### `issueSchemas.new(project, title, text)````var issueSchemas = Issues.schemas```js### schemas```pulls.deinit(cb)```jsyour program to exit or free up resources.streams, you should call `deinit` when you are done with the issues and wantDeinit the issues object. Closes all live streams. Since `issues` uses live#### deinit: async closed (false), or not (null) - `mention.open` (boolean?): whether the issue is updated to be open (true),- `mention` (object?): mention object, with properties like- `issue` (Issue): issue to check for update- `msg` (Msg in metadata): message to checkGet a mention of an issue in a message, if any```var mention = issueSchemas.getMention(issue, msg)