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	constructor()

Member Summary

Public Members
public	cachedLookup: *
public	cachedOpDocs: *
public	opLookupFilename: *
public	opdocsFilename: *
public get	utilName: *

Private Members
private	_rebuildOpDocCache: boolean

Method Summary

Public Methods
public	addOpToLookup(opId: , opName: )
public	addOpsToLookup(ops: *, clearFiles: boolean, haltOnError: boolean)
public	buildOpDocs(opName: ):
public	cleanOpDocData(obj: ):
public	getAllExtensionDocs(filterOldVersions: boolean, filterDeprecated: boolean, publicOnly: boolean): *
public	getCachedOpLookup(): *
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	getProjectOpDependencies(project: ):
public	hasExample(opname: , opDocs: ): *
public	hasScreenshot(opname: , opDocs: ): boolean
public	makeImportable(opDoc: ):
public	makeReadable(opDocs: ):
public	rebuildOpCaches(cb: *, scopes: string[], clearFiles: boolean, haltOnError: boolean)
public	removeOpNameFromLookup(opName: *)
public	removeOpNamesFromLookup(opNames: *)
public	replaceOpNameInLookup(oldName: , newName: )
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:

Name	Type	Attribute	Description
opId	*
opName	*

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

Params:

Name	Type	Attribute	Description
ops	*
clearFiles	boolean	optional default: false
haltOnError	boolean	optional default: false

public buildOpDocs(opName: ): source

Params:

Name	Type	Attribute	Description
opName	*

Return:

public cleanOpDocData(obj: ): source

Params:

Name	Type	Attribute	Description
obj	*

Return:

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

Params:

Name	Type	Attribute	Description
filterOldVersions	boolean	optional default: false
filterDeprecated	boolean	optional default: false
publicOnly	boolean	optional default: true

Return:

public getCachedOpLookup(): * source

Return:

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

Params:

Name	Type	Attribute	Description
collectionName	*
currentUser	*

Return:

public getCoreLibs(project: ): source

Params:

Name	Type	Attribute	Description
project	*

Return:

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

Params:

Name	Type	Attribute	Description
opName	*
docs	undefined	optional default: undefined

Return:

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

Params:

Name	Type	Attribute	Description
opname	*
opDocs	*

Return:

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

Params:

Name	Type	Attribute	Description
extensionName	*
filterOldVersions	boolean	optional default: false
filterDeprecated	boolean	optional default: false

Return:

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

Params:

Name	Type	Attribute	Description
extensionName	*
currentUser	*

Return:

public getOpDocMd(opname: ): source

Params:

Name	Type	Attribute	Description
opname	*

Return:

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

Params:

Name	Type	Attribute	Description
filterOldVersions	*
filterDeprecated	*

Return:

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

Params:

Name	Type	Attribute	Description
opNames	*
currentUser	*

Return:

public getOpDocsFromFile(opName: ): source

Params:

Name	Type	Attribute	Description
opName	*

Return:

public getProjectLibs(project: ): source

Params:

Name	Type	Attribute	Description
project	*

Return:

public getProjectOpDependencies(project: ): source

Params:

Name	Type	Attribute	Description
project	*

Return:

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

Params:

Name	Type	Attribute	Description
opname	*
opDocs	*

Return:

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

Params:

Name	Type	Attribute	Description
opname	*
opDocs	*

Return:

boolean

public makeImportable(opDoc: ): source

Params:

Name	Type	Attribute	Description
opDoc	*

Return:

public makeReadable(opDocs: ): source

Params:

Name	Type	Attribute	Description
opDocs	*

Return:

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

Params:

Name	Type	Attribute	Description
cb	*
scopes	string[]	optional default: ["core"]
clearFiles	boolean	optional default: false
haltOnError	boolean	optional default: false

public removeOpNameFromLookup(opName: *) source

Params:

Name	Type	Attribute	Description
opName	*

public removeOpNamesFromLookup(opNames: *) source

Params:

Name	Type	Attribute	Description
opNames	*

public replaceOpNameInLookup(oldName: , newName: ) source

Params:

Name	Type	Attribute	Description
oldName	*
newName	*

public updateOpDocs(opName: ): source

Params:

Name	Type	Attribute	Description
opName	*

Return:

Private Methods

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

Params:

Name	Type	Attribute	Description
namespaceName	*
shortName	*
team	*
opNames	*[]	optional default: []
filterOldVersions	boolean	optional default: false
filterDeprecated	boolean	optional default: false

SharedDocUtil

Extends:

Constructor Summary

Member Summary

Method Summary

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:

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

Params:

public buildOpDocs(opName: *): * source

Params:

Return:

public cleanOpDocData(obj: *): * source

Params:

Return:

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

Params:

Return:

public getCachedOpLookup(): * source

Return:

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

Params:

Return:

public getCoreLibs(project: *): * source

Params:

Return:

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

Params:

Return:

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

Params:

Return:

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

Params:

Return:

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

Params:

Return:

public getOpDocMd(opname: *): * source

Params:

Return:

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

Params:

Return:

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

Params:

Return:

public getOpDocsFromFile(opName: *): * source

Params:

Return:

public getProjectLibs(project: *): * source

Params:

Return:

public getProjectOpDependencies(project: *): * source

Params:

Return:

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

Params:

Return:

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

Params:

Return:

public makeImportable(opDoc: *): * source

Params:

Return:

public makeReadable(opDocs: *): * source

Params:

Return:

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

public addOpToLookup(opId: , opName: ) source

public buildOpDocs(opName: ): source

public cleanOpDocData(obj: ): source

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

public getCoreLibs(project: ): source

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

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

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

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

public getOpDocMd(opname: ): source

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

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

public getOpDocsFromFile(opName: ): source

public getProjectLibs(project: ): source

public getProjectOpDependencies(project: ): source

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

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

public makeImportable(opDoc: ): source

public makeReadable(opDocs: ): source

public replaceOpNameInLookup(oldName: , newName: ) source

public updateOpDocs(opName: ): source

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