INFO

This API documentation is for FAKE version 5.0 or later. The old API documentation can be found here for migration or here for fake 4

This is part of the Fake.Core.Context module.

Context

This module tracks the context of the build. This allows us to run some modules without any context and change behavior depending on the context (For example Fake.Process kills all processes when the Fake Context exists, but it should not when used as library)

Nested types and modules

Functions and values

Function or valueDescription
fakeVar(name)
Signature: name:string -> (unit -> 'a option) * (unit -> unit) * ('a -> unit)
Type parameters: 'a Attributes:
[<Obsolete("Please use 'Fake.Core.FakeVar.define' instead")>]
OBSOLETE

Please use 'Fake.Core.FakeVar.define' instead

fakeVarAllowNoContext(name)
Signature: name:string -> (unit -> 'a option) * (unit -> unit) * ('a -> unit)
Type parameters: 'a Attributes:
[<Obsolete("Please use 'Fake.Core.FakeVar.defineAllowNoContext' instead")>]
OBSOLETE

Please use 'Fake.Core.FakeVar.defineAllowNoContext' instead

forceFakeContext()
Signature: unit -> FakeExecutionContext
getExecutionContext()
Signature: unit -> RuntimeContext
getFakeContext name f
Signature: name:string -> f:FakeExecutionContext -> obj option
getFakeExecutionContext(e)
Signature: e:RuntimeContext -> FakeExecutionContext option
getFakeVar(name)
Signature: name:string -> 'a option
Type parameters: 'a Attributes:
[<Obsolete("Please use 'Fake.Core.FakeVar.get' instead")>]
OBSOLETE

Please use 'Fake.Core.FakeVar.get' instead

isFakeContext()
Signature: unit -> bool
removeFakeContext name f
Signature: name:string -> f:FakeExecutionContext -> obj option
removeFakeVar(name)
Signature: name:string -> 'a option
Type parameters: 'a Attributes:
[<Obsolete("Please use 'Fake.Core.FakeVar.remove' instead")>]
OBSOLETE

Please use 'Fake.Core.FakeVar.remove' instead

setExecutionContext(e)
Signature: e:RuntimeContext -> unit
setFakeContext name v updateF f
Signature: name:string -> v:obj -> updateF:(obj -> obj) -> f:FakeExecutionContext -> obj
setFakeVar name v
Signature: name:string -> v:'a -> 'a
Type parameters: 'a Attributes:
[<Obsolete("Please use 'Fake.Core.FakeVar.set' instead")>]
OBSOLETE

Please use 'Fake.Core.FakeVar.set' instead