Class Tags

Class used to store custom tags

Hierarchy

Tags

Index

Methods

Methods

Static AddTagsToSearch playground for AddTagsTo

AddTagsTo(obj: any, tagsString: string): void

- Defined in .temp/docdirectory/doc.d.ts:69948
Adds tags to an object

Parameters
- obj: any
  
  defines the object to use
- tagsString: string
  
  defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags. A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
Returns void

Static DisableForSearch playground for DisableFor

DisableFor(obj: any): void

- Defined in .temp/docdirectory/doc.d.ts:69928
Removes tags support

Parameters
- obj: any
  
  defines the object to use
Returns void

Static EnableForSearch playground for EnableFor

EnableFor(obj: any): void

- Defined in .temp/docdirectory/doc.d.ts:69923
Adds support for tags on the given object

Parameters
- obj: any
  
  defines the object to use
Returns void

Static GetTagsSearch playground for GetTags

GetTags(obj: any, asString?: boolean): any

- Defined in .temp/docdirectory/doc.d.ts:69941
Gets the tags available on a given object

Parameters
- obj: any
  
  defines the object to use
- Optional asString: boolean
  
  defines if the tags must be returned as a string instead of an array of strings
Returns any

the tags

Static HasTagsSearch playground for HasTags

HasTags(obj: any): boolean

- Defined in .temp/docdirectory/doc.d.ts:69934
Gets a boolean indicating if the given object has tags

Parameters
- obj: any
  
  defines the object to use
Returns boolean

a boolean

Static MatchesQuerySearch playground for MatchesQuery

MatchesQuery(obj: any, tagsQuery: string): boolean

- Defined in .temp/docdirectory/doc.d.ts:69973
Defines if tags hosted on an object match a given query

Parameters
- obj: any
  
  defines the object to use
- tagsQuery: string
  
  defines the tag query
Returns boolean

a boolean

Static RemoveTagsFromSearch playground for RemoveTagsFrom

RemoveTagsFrom(obj: any, tagsString: string): void

- Defined in .temp/docdirectory/doc.d.ts:69960
Removes specific tags from a specific object

Parameters
- obj: any
  
  defines the object to use
- tagsString: string
  
  defines the tags to remove
Returns void