Tags

Class used to store custom tags

Hierarchy

  • Tags

Index

Methods

Static AddTagsTo

Find examples in Playground
  • AddTagsTo(obj: any, tagsString: string): void
  • 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 DisableFor

Find examples in Playground
  • DisableFor(obj: any): void
  • Removes tags support

    Parameters

    • obj: any

      defines the object to use

    Returns void

Static EnableFor

Find examples in Playground
  • EnableFor(obj: any): void
  • Adds support for tags on the given object

    Parameters

    • obj: any

      defines the object to use

    Returns void

Static GetTags

Find examples in Playground
  • GetTags(obj: any, asString?: boolean): any
  • 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 HasTags

Find examples in Playground
  • HasTags(obj: any): boolean
  • Gets a boolean indicating if the given object has tags

    Parameters

    • obj: any

      defines the object to use

    Returns boolean

    a boolean

Static MatchesQuery

Find examples in Playground
  • MatchesQuery(obj: any, tagsQuery: string): boolean
  • 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 RemoveTagsFrom

Find examples in Playground
  • RemoveTagsFrom(obj: any, tagsString: string): void
  • Removes specific tags from a specific object

    Parameters

    • obj: any

      defines the object to use

    • tagsString: string

      defines the tags to remove

    Returns void

Generated using TypeDoc