jsdoc fixes
This commit is contained in:
		
							parent
							
								
									9f9f465238
								
							
						
					
					
						commit
						e4a5f2caec
					
				@ -10,13 +10,14 @@
 | 
				
			|||||||
    "watch": "rollup -wc",
 | 
					    "watch": "rollup -wc",
 | 
				
			||||||
    "debug": "concurrently 'rollup -wc' 'cutest-serve build/y.test.js -o'",
 | 
					    "debug": "concurrently 'rollup -wc' 'cutest-serve build/y.test.js -o'",
 | 
				
			||||||
    "lint": "standard **/*.js",
 | 
					    "lint": "standard **/*.js",
 | 
				
			||||||
    "docs": "ls -al && rm -rf docs; ! jsdoc --configure ./.jsdoc.json --verbose --readme ./README.md --package ./package.json",
 | 
					    "docs": "rm -rf docs; ! jsdoc --configure ./.jsdoc.json --verbose --readme ./README.md --package ./package.json",
 | 
				
			||||||
    "serve-docs": "npm run docs && serve ./docs/",
 | 
					    "serve-docs": "npm run docs && serve ./docs/",
 | 
				
			||||||
    "postversion": "npm run build"
 | 
					    "postversion": "npm run build"
 | 
				
			||||||
  },
 | 
					  },
 | 
				
			||||||
  "files": [
 | 
					  "files": [
 | 
				
			||||||
    "src/*",
 | 
					    "src/*",
 | 
				
			||||||
    ".esdoc.json",
 | 
					    ".esdoc.json",
 | 
				
			||||||
 | 
					    ".jsdoc.json",
 | 
				
			||||||
    "docs/*",
 | 
					    "docs/*",
 | 
				
			||||||
    "build/*",
 | 
					    "build/*",
 | 
				
			||||||
    "lib/*",
 | 
					    "lib/*",
 | 
				
			||||||
 | 
				
			|||||||
@ -12,12 +12,13 @@ import { Item } from '../structs/Item.js' // eslint-disable-line
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
 * Event that describes the changes on a YArray
 | 
					 * Event that describes the changes on a YArray
 | 
				
			||||||
 *
 | 
					 */
 | 
				
			||||||
 | 
					export class YArrayEvent extends YEvent {
 | 
				
			||||||
 | 
					  /**
 | 
				
			||||||
   * @param {YArray} yarray The changed type
 | 
					   * @param {YArray} yarray The changed type
 | 
				
			||||||
   * @param {Boolean} remote Whether the changed was caused by a remote peer
 | 
					   * @param {Boolean} remote Whether the changed was caused by a remote peer
 | 
				
			||||||
   * @param {Transaction} transaction The transaction object
 | 
					   * @param {Transaction} transaction The transaction object
 | 
				
			||||||
   */
 | 
					   */
 | 
				
			||||||
export class YArrayEvent extends YEvent {
 | 
					 | 
				
			||||||
  constructor (yarray, remote, transaction) {
 | 
					  constructor (yarray, remote, transaction) {
 | 
				
			||||||
    super(yarray)
 | 
					    super(yarray)
 | 
				
			||||||
    this.remote = remote
 | 
					    this.remote = remote
 | 
				
			||||||
 | 
				
			|||||||
@ -10,12 +10,13 @@ import { YEvent } from '../utils/YEvent.js'
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
 * Event that describes the changes on a YMap.
 | 
					 * Event that describes the changes on a YMap.
 | 
				
			||||||
 *
 | 
					 */
 | 
				
			||||||
 | 
					export class YMapEvent extends YEvent {
 | 
				
			||||||
 | 
					  /**
 | 
				
			||||||
   * @param {YMap} ymap The YArray that changed.
 | 
					   * @param {YMap} ymap The YArray that changed.
 | 
				
			||||||
   * @param {Set<any>} subs The keys that changed.
 | 
					   * @param {Set<any>} subs The keys that changed.
 | 
				
			||||||
   * @param {boolean} remote Whether the change was created by a remote peer.
 | 
					   * @param {boolean} remote Whether the change was created by a remote peer.
 | 
				
			||||||
   */
 | 
					   */
 | 
				
			||||||
export class YMapEvent extends YEvent {
 | 
					 | 
				
			||||||
  constructor (ymap, subs, remote) {
 | 
					  constructor (ymap, subs, remote) {
 | 
				
			||||||
    super(ymap)
 | 
					    super(ymap)
 | 
				
			||||||
    this.keysChanged = subs
 | 
					    this.keysChanged = subs
 | 
				
			||||||
 | 
				
			|||||||
@ -461,10 +461,11 @@ class YTextEvent extends YArrayEvent {
 | 
				
			|||||||
 * This type replaces y-richtext as this implementation is able to handle
 | 
					 * This type replaces y-richtext as this implementation is able to handle
 | 
				
			||||||
 * block formats (format information on a paragraph), embeds (complex elements
 | 
					 * block formats (format information on a paragraph), embeds (complex elements
 | 
				
			||||||
 * like pictures and videos), and text formats (**bold**, *italic*).
 | 
					 * like pictures and videos), and text formats (**bold**, *italic*).
 | 
				
			||||||
 *
 | 
					 | 
				
			||||||
 * @param {String} string The initial value of the YText.
 | 
					 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
export class YText extends YArray {
 | 
					export class YText extends YArray {
 | 
				
			||||||
 | 
					  /**
 | 
				
			||||||
 | 
					   * @param {String} string The initial value of the YText.
 | 
				
			||||||
 | 
					   */
 | 
				
			||||||
  constructor (string) {
 | 
					  constructor (string) {
 | 
				
			||||||
    super()
 | 
					    super()
 | 
				
			||||||
    if (typeof string === 'string') {
 | 
					    if (typeof string === 'string') {
 | 
				
			||||||
 | 
				
			|||||||
@ -10,8 +10,6 @@ import { DomBinding } from '../bindings/dom/DomBinding.js' // eslint-disable-lin
 | 
				
			|||||||
/**
 | 
					/**
 | 
				
			||||||
 * Represents text in a Dom Element. In the future this type will also handle
 | 
					 * Represents text in a Dom Element. In the future this type will also handle
 | 
				
			||||||
 * simple formatting information like bold and italic.
 | 
					 * simple formatting information like bold and italic.
 | 
				
			||||||
 *
 | 
					 | 
				
			||||||
 * @param {String} arg1 Initial value.
 | 
					 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
export class YXmlText extends YText {
 | 
					export class YXmlText extends YText {
 | 
				
			||||||
  /**
 | 
					  /**
 | 
				
			||||||
 | 
				
			|||||||
@ -8,6 +8,9 @@ import * as ID from '../utils/ID.js'
 | 
				
			|||||||
 * @typedef {Map<number, number>} StateSet
 | 
					 * @typedef {Map<number, number>} StateSet
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/**
 | 
				
			||||||
 | 
					 * @private
 | 
				
			||||||
 | 
					 */
 | 
				
			||||||
export class StateStore {
 | 
					export class StateStore {
 | 
				
			||||||
  constructor (y) {
 | 
					  constructor (y) {
 | 
				
			||||||
    this.y = y
 | 
					    this.y = y
 | 
				
			||||||
 | 
				
			|||||||
@ -25,11 +25,12 @@ import { Decoder } from '../lib/decoding.js' // eslint-disable-line
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
 * A Yjs instance handles the state of shared data.
 | 
					 * A Yjs instance handles the state of shared data.
 | 
				
			||||||
 *
 | 
					 */
 | 
				
			||||||
 | 
					export class Y extends NamedEventHandler {
 | 
				
			||||||
 | 
					  /**
 | 
				
			||||||
   * @param {string} room Users in the same room share the same content
 | 
					   * @param {string} room Users in the same room share the same content
 | 
				
			||||||
   * @param {Object} conf configuration
 | 
					   * @param {Object} conf configuration
 | 
				
			||||||
   */
 | 
					   */
 | 
				
			||||||
export class Y extends NamedEventHandler {
 | 
					 | 
				
			||||||
  constructor (room, conf = {}) {
 | 
					  constructor (room, conf = {}) {
 | 
				
			||||||
    super()
 | 
					    super()
 | 
				
			||||||
    this.gcEnabled = conf.gc || false
 | 
					    this.gcEnabled = conf.gc || false
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user