Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

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

TypeDescription
FakeExecutionContext
RuntimeContext
RuntimeContextWrapper

Functions and values

Function or valueDescription
fake_ExecutionType
Signature: string
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
getContext(name)
Signature: name:string -> obj
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

setContext name o
Signature: name:string -> o:obj -> unit
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