Variable Identifier

Identifier: {
    accessesInternal(this: void, id: Identifier): undefined | boolean;
    dotdotdot(this: void): BrandedIdentifier;
    getName(this: void, id: Identifier): BrandedIdentifier;
    getNamespace(this: void, id: Identifier): undefined | BrandedNamespace;
    isDotDotDotAccess(this: void, id: Identifier): boolean;
    make(
        this: void,
        name: BrandedIdentifier,
        namespace?: BrandedNamespace,
        internal?: boolean,
    ): Identifier;
    mapName(
        this: void,
        id: Identifier,
        fn: (name: BrandedIdentifier) => BrandedIdentifier,
    ): Identifier;
    mapNamespace(
        this: void,
        id: Identifier,
        fn: (ns: BrandedNamespace) => BrandedNamespace,
    ): Identifier;
    matches(
        this: void,
        id: Identifier,
        target: Identifier,
        s3?: boolean,
    ): boolean;
    parse(this: void, str: string): Identifier;
    toArray(
        this: void,
        id: Identifier,
    ): [BrandedIdentifier, undefined | BrandedNamespace, undefined | boolean];
    toString(this: void, id: Identifier): string;
}

Helper functions to work with identifiers. Use Identifier.matches to check if two identifiers match according to R's scoping rules!

Type declaration

accessesInternal:function
- accessesInternal(this: void, id: Identifier): undefined | boolean
  Check if the identifier accesses internal objects (:::)
  Parameters
  - this: void
  - id: Identifier
  Returns undefined | boolean
  - Defined in src/dataflow/environments/identifier.ts:80
dotdotdot:function
- dotdotdot(this: void): BrandedIdentifier
  Special identifier for the ... argument
  Parameters
  - this: void
  Returns BrandedIdentifier
  - Defined in src/dataflow/environments/identifier.ts:136
getName:function
- getName(this: void, id: Identifier): BrandedIdentifier
  Get the name part of the identifier
  Parameters
  - this: void
  - id: Identifier
  Returns BrandedIdentifier
  - Defined in src/dataflow/environments/identifier.ts:68
getNamespace:function
- getNamespace(this: void, id: Identifier): undefined | BrandedNamespace
  Get the namespace part of the identifier, undefined if there is none
  Parameters
  - this: void
  - id: Identifier
  Returns undefined | BrandedNamespace
  - Defined in src/dataflow/environments/identifier.ts:74
isDotDotDotAccess:function
- isDotDotDotAccess(this: void, id: Identifier): boolean
  Check if the identifier is the special ... argument / or one of its accesses like ..1, ..2, etc. This always returns false for namespaced identifiers.
  Parameters
  - this: void
  - id: Identifier
  Returns boolean
  - Defined in src/dataflow/environments/identifier.ts:143
make:function
- make(
      this: void,
      name: BrandedIdentifier,
      namespace?: BrandedNamespace,
      internal?: boolean,
  ): Identifier
  Create an identifier from its name and optional namespace. Please note that for internal to count, a namespace must be provided!
  Parameters
  - this: void
  - name: BrandedIdentifier
  - Optionalnamespace: BrandedNamespace
  - internal: boolean = false
  Returns Identifier
  - Defined in src/dataflow/environments/identifier.ts:42
mapName:function
- mapName(
      this: void,
      id: Identifier,
      fn: (name: BrandedIdentifier) => BrandedIdentifier,
  ): Identifier
  Functor over the name of the identifier
  Parameters
  - this: void
  - id: Identifier
  - fn: (name: BrandedIdentifier) => BrandedIdentifier
  Returns Identifier
  - Defined in src/dataflow/environments/identifier.ts:149
mapNamespace:function
- mapNamespace(
      this: void,
      id: Identifier,
      fn: (ns: BrandedNamespace) => BrandedNamespace,
  ): Identifier
  Functor over the namespace of the identifier
  Parameters
  - this: void
  - id: Identifier
  - fn: (ns: BrandedNamespace) => BrandedNamespace
  Returns Identifier
  - Defined in src/dataflow/environments/identifier.ts:159
matches:function
- matches(this: void, id: Identifier, target: Identifier, s3?: boolean): boolean
  Check if two identifiers match. This differs from eq! If the first identifier is not namespaced, it will match any namespace! If we search for S3 methods (s3=true), the target may have an additional suffix after a dot. If the first identifier is internal, it will match any target (internal or not).
  Parameters
  - this: void
  - id: Identifier
  - target: Identifier
  - s3: boolean = false
  Returns boolean
  - Defined in src/dataflow/environments/identifier.ts:114
parse:function
- parse(this: void, str: string): Identifier
  Parse an identifier from its string representation, Please note, that in R if one writes "pkg::a" this refers to a symbol named pkag::a and NOT to the namespaced identifier a in package pkg. In this scenario, see Identifier.make instead.
  Parameters
  - this: void
  - str: string
  Returns Identifier
  - Defined in src/dataflow/environments/identifier.ts:57
toArray:function
- toArray(
  this: void,
  id: Identifier,
  ): [BrandedIdentifier, undefined | BrandedNamespace, undefined | boolean]
  Convert the identifier to its array representation
  Parameters
  - this: void
  - id: Identifier
  Returns [BrandedIdentifier, undefined | BrandedNamespace, undefined | boolean]
  - Defined in src/dataflow/environments/identifier.ts:169
toString:function
- toString(this: void, id: Identifier): string
  Convert the identifier to a valid R string representation, this will properly quote namespaces that contain :: to avoid confusion.
  Parameters
  - this: void
  - id: Identifier
  Returns string
  Example
  Identifier.toString('a') // 'a' Identifier.toString(['a', 'pkg']) // 'pkg::a' Identifier.toString(['a', 'pkg:::internal', true]) // '"pkg:::internal":::a'
  - Defined in src/dataflow/environments/identifier.ts:94

Example

const id1 = Identifier.make('a', 'pkg');
const id2 = Identifier.parse('pkg::a');
const id3 = Identifier.parse('a');
Identifier.matches(id1, id2); // true
Identifier.matches(id3, id2); // true, as id3 has no namespace

Variable Identifier

Type declaration

accessesInternal:function

Parameters

Returns undefined | boolean

dotdotdot:function

Parameters

Returns BrandedIdentifier

getName:function

Parameters

Returns BrandedIdentifier

getNamespace:function

Parameters

Returns undefined | BrandedNamespace

isDotDotDotAccess:function

Parameters

Returns boolean

make:function

Parameters

Returns Identifier

mapName:function

Parameters

Returns Identifier

mapNamespace:function

Parameters

Returns Identifier

matches:function

Parameters

Returns boolean

parse:function

Parameters

Returns Identifier

toArray:function

Parameters

Returns [BrandedIdentifier, undefined | BrandedNamespace, undefined | boolean]

toString:function

Parameters

Returns string

Example

Example

Settings