Variable Identifier

Identifier: {
    accessesInternal(this: void, id: Identifier): boolean | undefined;
    dotdotdot(this: void): BrandedIdentifier;
    from(
        this: void,
        arr:
            | [BrandedIdentifier, BrandedNamespace]
            | [BrandedIdentifier, BrandedNamespace, boolean],
    ): Identifier;
    getName(this: void, id: Identifier): BrandedIdentifier;
    getNamespace(this: void, id: Identifier): BrandedNamespace | undefined;
    is(this: void, id: unknown): id is Identifier;
    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;
    name: "Identifier";
    parse(this: void, str: string): Identifier;
    toArray(
        this: void,
        id: Identifier,
    ): [BrandedIdentifier, BrandedNamespace | undefined, boolean | undefined];
    toQualified(
        this: void,
        origins: readonly Origin[] | undefined,
        name?: Identifier,
        qualifyBaseR?: boolean,
    ): Identifier | undefined;
    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): boolean | undefined
  Check if the identifier accesses internal objects (:::)
  Parameters
  - this: void
  - id: Identifier
  Returns boolean | undefined
  - Defined in src/dataflow/environments/identifier.ts:114
dotdotdot: function
- dotdotdot(this: void): BrandedIdentifier
  Special identifier for the ... argument
  Parameters
  - this: void
  Returns BrandedIdentifier
  - Defined in src/dataflow/environments/identifier.ts:170
from: function
- from(
      this: void,
      arr:
          | [BrandedIdentifier, BrandedNamespace]
          | [BrandedIdentifier, BrandedNamespace, boolean],
  ): Identifier
  Fast-path factory: returns the tuple as-is with no allocation or runtime checks. Use for static built-in config entries where name is a compile-time constant with no backticks.
  Parameters
  - this: void
  - arr:
    | [BrandedIdentifier, BrandedNamespace]
    | [BrandedIdentifier, BrandedNamespace, boolean]
  Returns Identifier
  Example
  Identifier.from(['map', 'purrr']) // ['map', 'purrr'] Identifier.from(['map', 'purrr', true]) // ['map', 'purrr', true]
  - Defined in src/dataflow/environments/identifier.ts:67
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:102
getNamespace: function
- getNamespace(this: void, id: Identifier): BrandedNamespace | undefined
  Get the namespace part of the identifier, undefined if there is none
  Parameters
  - this: void
  - id: Identifier
  Returns BrandedNamespace | undefined
  - Defined in src/dataflow/environments/identifier.ts:108
is: function
- is(this: void, id: unknown): id is Identifier
  Verify whether an unknown element has a valid identifier shape!
  Parameters
  - this: void
  - id: unknown
  Returns id is Identifier
  - Defined in src/dataflow/environments/identifier.ts:73
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:177
make: function
- make(
      this: void,
      name: BrandedIdentifier,
      namespace?: BrandedNamespace,
      internal?: boolean,
  ): Identifier
  Creates an identifier. Strips surrounding backticks from the name. Prefer Identifier.from for static config entries where namespace is always present and name has no backticks.
  Parameters
  - this: void
  - name: BrandedIdentifier
  - Optionalnamespace: BrandedNamespace
  - internal: boolean = false
  Returns Identifier
  - Defined in src/dataflow/environments/identifier.ts:48
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:183
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:193
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:148
Readonlyname: "Identifier"
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 pkg::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:91
toArray: function
- toArray(
  this: void,
  id: Identifier,
  ): [BrandedIdentifier, BrandedNamespace | undefined, boolean | undefined]
  Convert the identifier to its array representation
  Parameters
  - this: void
  - id: Identifier
  Returns [BrandedIdentifier, BrandedNamespace | undefined, boolean | undefined]
  - Defined in src/dataflow/environments/identifier.ts:203
toQualified: function
- toQualified(
      this: void,
      origins: readonly Origin[] | undefined,
      name?: Identifier,
      qualifyBaseR?: boolean,
  ): Identifier | undefined
  The package-qualified identifier of a call, resolved in order of decreasing certainty:
  1. a package export the origins resolve to (map() with purrr loaded yields purrr::map),
  2. an already-namespaced name returned unchanged (an explicit pkg::fn call),
  3. with qualifyBaseR, a bare base-R call qualified from its exporting package via baseRExportOwner (sd yields stats::sd), needing no loaded database or graph edge and skipped when the call resolves to a user definition, so a local sd() stays bare.
  Returns undefined when none apply. Steps 2 and 3 need the call's name.
  Parameters
  - this: void
  - origins: readonly Origin[] | undefined
  - Optionalname: Identifier
  - qualifyBaseR: boolean = true
    whether to also qualify a bare base-R call from its exporting package (default true)
  Returns Identifier | undefined
  See
  Dataflow.qualify - the compact form, if you have the call's id and its graph
  - Defined in src/dataflow/environments/identifier.ts:222
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:128

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 boolean | undefined

dotdotdot: function

Parameters

Returns BrandedIdentifier

from: function

Parameters

Returns Identifier

Example

getName: function

Parameters

Returns BrandedIdentifier

getNamespace: function

Parameters

Returns BrandedNamespace | undefined

is: function

Parameters

Returns id is Identifier

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

Readonlyname: "Identifier"

parse: function

Parameters

Returns Identifier

toArray: function

Parameters

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

toQualified: function

Parameters

Returns Identifier | undefined

See

toString: function

Parameters

Returns string

Example

Example

Settings

`Readonly`name: "Identifier"