Variable REnvironmentConst

Type Declaration

• Readonlyappend: {
      (
          base: REnvironmentInformation,
          next: REnvironmentInformation | undefined,
      ): REnvironmentInformation;
      (
          base: REnvironmentInformation | undefined,
          next: REnvironmentInformation,
      ): REnvironmentInformation;
      (base: undefined, next: undefined): undefined;
      (
          base: REnvironmentInformation | undefined,
          next: REnvironmentInformation | undefined,
      ): REnvironmentInformation | undefined;
  }

  Adds all writes of next to base as things that might happen; see appendEnvironment.

• ReadonlyattachAt: (
      this: void,
      current: Environment,
      blockTop: Environment,
      blockBottom: Environment,
      pos?: number,
  ) => Environment

  Attaches a package block at a search() position, below the global by default; see attachPackageAt.

• ReadonlyattachedPackages: (this: void, env: Environment) => Set<string>

  The packages on the search path; see attachedPackagesOf.

• ReadonlycleanOf: (__namedParameters: REnvironmentInformation) => REnvironmentInformation

  The search path of the environment with an empty global frame: attached packages stay visible, global binds do not; see cleanEnvOf.

• Readonlyclone: (
      environment: REnvironmentInformation,
      recurseParents?: boolean,
  ) => REnvironmentInformation

  Clones the environment information, with or without its parents; see cloneEnvironmentInformation.

• Readonlydefine: (
      definition: IdentifierDefinition & { name: Identifier },
      superAssign: boolean | undefined,
      __namedParameters: REnvironmentInformation,
      append?: boolean,
  ) => REnvironmentInformation

  Defines an identifier in the environment, as a super assignment if asked; returns the new environment information.

• ReadonlyfindBuiltIn: (this: void, env: Environment) => Environment

  Walks up to the built-in environment; see findBuiltInEnvironment.

• ReadonlyfindGlobal: (this: void, env: Environment) => Environment

  Walks up to the global environment (.GlobalEnv); see findGlobalEnvironment.

• Readonlyframes: (this: void, env: Environment) => Generator<Environment, void, undefined>

  The frames from an environment outwards, without the built-in one; see framesOf.

• Readonlyname: "REnvironment"

• Readonlyoverwrite: {
      (
          base: REnvironmentInformation,
          next: REnvironmentInformation | undefined,
          applyCds?: readonly ControlDependency[],
      ): REnvironmentInformation;
      (
          base: REnvironmentInformation | undefined,
          next: REnvironmentInformation,
          applyCds?: readonly ControlDependency[],
      ): REnvironmentInformation;
      (
          base: undefined,
          next: undefined,
          applyCds?: readonly ControlDependency[],
      ): undefined;
      (
          base: REnvironmentInformation | undefined,
          next: REnvironmentInformation | undefined,
          applyCds?: readonly ControlDependency[],
      ): REnvironmentInformation | undefined;
  }

  Lets the definitions of next replace those of base by name; see overwriteEnvironment.

• ReadonlypopLocal: (__namedParameters: REnvironmentInformation) => REnvironmentInformation

  Removes the top local scope, see REnvironment.pushLocal for the counterpart; see popLocalEnvironment.

• ReadonlypushLocal: (__namedParameters: REnvironmentInformation) => REnvironmentInformation

  Adds a local scope on top, see REnvironment.popLocal for the counterpart; see pushLocalEnvironment.

• ReadonlysearchPath: (this: void, env: Environment) => Generator<Environment, void, undefined>

  The layers below the global environment, innermost first; see searchPathOf.

• ReadonlysearchPosition: (this: void, env: Environment, name: string) => number | undefined

  The search() position of a named entry; see searchPositionOf.