Home Reference Source 
import {SharedDocUtil} from 'cables-shared-api'
public class | source

SharedDocUtil

Extends:

cables_dev/shared/api/shared_util.js~SharedUtil → SharedDocUtil

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public
public
public
public
public get
Private Members
private

Method Summary

Public Methods
public

addOpToLookup(opId: *, opName: *)

public

addOpsToLookup(ops: *, clearFiles: boolean)

public

buildOpDocs(opName: *): *

public

cleanOpDocData(obj: *): *

public

getAllExtensionDocs(filterOldVersions: boolean, filterDeprecated: boolean): *

public
public

getCollectionOpDocs(collectionName: *, currentUser: *): *

public

getCoreLibs(project: *): *

public

getDocForOp(opName: *, docs: undefined): *

public

getExampleProjectId(opname: *, opDocs: *): *

public

getExtensionDoc(extensionName: *, filterOldVersions: boolean, filterDeprecated: boolean): *

public

getExtensionOpDocs(extensionName: *, currentUser: *): *

public

getOpDocMd(opname: *): *

public

getOpDocs(filterOldVersions: *, filterDeprecated: *): *

public

getOpDocsForCollections(opNames: *, currentUser: *): *

public

getOpDocsFromFile(opName: *): *

public

getProjectLibs(project: *): *

public

hasExample(opname: *, opDocs: *): *

public

hasScreenshot(opname: *, opDocs: *): boolean

public

makeReadable(opDocs: *): *

public

rebuildOpCaches(cb: *, scopes: string[], clearFiles: boolean)

public
public
public

replaceOpNameInLookup(oldName: *, newName: *)

public

setOpLinks(str: *): *

public

updateOpDocs(opName: *): *

Private Methods
private

_getNamespaceDocs(namespaceName: *, shortName: *, team: *, opNames: *[], filterOldVersions: boolean, filterDeprecated: boolean): *

Public Constructors

public constructor() source

Public Members

public cachedLookup: * source

public cachedOpDocs: * source

public opLookupFilename: * source

public opdocsFilename: * source

public get utilName: * source

Private Members

private _rebuildOpDocCache: boolean source

Public Methods

public addOpToLookup(opId: *, opName: *) source

Params:

NameTypeAttributeDescription
opId *
opName *

public addOpsToLookup(ops: *, clearFiles: boolean) source

Params:

NameTypeAttributeDescription
ops *
clearFiles boolean
  • optional
  • default: false

public buildOpDocs(opName: *): * source

Params:

NameTypeAttributeDescription
opName *

Return:

*

public cleanOpDocData(obj: *): * source

Params:

NameTypeAttributeDescription
obj *

Return:

*

public getAllExtensionDocs(filterOldVersions: boolean, filterDeprecated: boolean): * source

Params:

NameTypeAttributeDescription
filterOldVersions boolean
  • optional
  • default: false
filterDeprecated boolean
  • optional
  • default: false

Return:

*

public getCachedOpLookup(): * source

Return:

*

public getCollectionOpDocs(collectionName: *, currentUser: *): * source

Params:

NameTypeAttributeDescription
collectionName *
currentUser *

Return:

*

public getCoreLibs(project: *): * source

Params:

NameTypeAttributeDescription
project *

Return:

*

public getDocForOp(opName: *, docs: undefined): * source

Params:

NameTypeAttributeDescription
opName *
docs undefined
  • optional
  • default: undefined

Return:

*

public getExampleProjectId(opname: *, opDocs: *): * source

Params:

NameTypeAttributeDescription
opname *
opDocs *

Return:

*

public getExtensionDoc(extensionName: *, filterOldVersions: boolean, filterDeprecated: boolean): * source

Params:

NameTypeAttributeDescription
extensionName *
filterOldVersions boolean
  • optional
  • default: false
filterDeprecated boolean
  • optional
  • default: false

Return:

*

public getExtensionOpDocs(extensionName: *, currentUser: *): * source

Params:

NameTypeAttributeDescription
extensionName *
currentUser *

Return:

*

public getOpDocMd(opname: *): * source

Params:

NameTypeAttributeDescription
opname *

Return:

*

public getOpDocs(filterOldVersions: *, filterDeprecated: *): * source

Params:

NameTypeAttributeDescription
filterOldVersions *
filterDeprecated *

Return:

*

public getOpDocsForCollections(opNames: *, currentUser: *): * source

Params:

NameTypeAttributeDescription
opNames *
currentUser *

Return:

*

public getOpDocsFromFile(opName: *): * source

Params:

NameTypeAttributeDescription
opName *

Return:

*

public getProjectLibs(project: *): * source

Params:

NameTypeAttributeDescription
project *

Return:

*

public hasExample(opname: *, opDocs: *): * source

Params:

NameTypeAttributeDescription
opname *
opDocs *

Return:

*

public hasScreenshot(opname: *, opDocs: *): boolean source

Params:

NameTypeAttributeDescription
opname *
opDocs *

Return:

boolean

public makeReadable(opDocs: *): * source

Params:

NameTypeAttributeDescription
opDocs *

Return:

*

public rebuildOpCaches(cb: *, scopes: string[], clearFiles: boolean) source

Params:

NameTypeAttributeDescription
cb *
scopes string[]
  • optional
  • default: ["core"]
clearFiles boolean
  • optional
  • default: false

public removeOpNameFromLookup(opName: *) source

Params:

NameTypeAttributeDescription
opName *

public removeOpNamesFromLookup(opNames: *) source

Params:

NameTypeAttributeDescription
opNames *

public replaceOpNameInLookup(oldName: *, newName: *) source

Params:

NameTypeAttributeDescription
oldName *
newName *

Params:

NameTypeAttributeDescription
str *

Return:

*

public updateOpDocs(opName: *): * source

Params:

NameTypeAttributeDescription
opName *

Return:

*

Private Methods

private _getNamespaceDocs(namespaceName: *, shortName: *, team: *, opNames: *[], filterOldVersions: boolean, filterDeprecated: boolean): * source

Params:

NameTypeAttributeDescription
namespaceName *
shortName *
team *
opNames *[]
  • optional
  • default: []
filterOldVersions boolean
  • optional
  • default: false
filterDeprecated boolean
  • optional
  • default: false

Return:

*