docs/Typealiases.html
The following type aliases are available globally.
`
AsyncSpecBase
`
- `
AsyncSpecBase
`
Undocumented
Swift
public typealias AsyncSpecBase = XCTestCase
`
FileString
`
- `
FileString
`
Undocumented
Swift
public typealias FileString = String
`
QuickConfigurer
`
A closure that temporarily exposes a QCKConfiguration object within the scope of the closure.
Swift
public typealias QuickConfigurer = (_ configuration: QCKConfiguration) -> Void
`
ExampleFilter
`
A closure that, given metadata about an example, returns a boolean value indicating whether that example should be run.
Swift
public typealias ExampleFilter = (_ example: ExampleBase) -> Bool
`
BeforeExampleAsyncClosure
` Asynchronous
An async throwing closure executed before an example is run.
Swift
public typealias BeforeExampleAsyncClosure = () async throws -> Void
`
BeforeExampleClosure
`
A throwing closure executed before an example is run.
Swift
public typealias BeforeExampleClosure = @MainActor () throws -> Void
`
BeforeExampleNonThrowingClosure
`
A closure executed before an example is run. This is only used by ObjC.
Swift
public typealias BeforeExampleNonThrowingClosure = @MainActor () -> Void
`
BeforeExampleWithMetadataAsyncClosure
` Asynchronous
An async throwing closure executed before an example is run. The closure is given example metadata, which contains information about the example that is about to be run.
Swift
public typealias BeforeExampleWithMetadataAsyncClosure = (_ exampleMetadata: ExampleMetadata) async throws -> Void
`
BeforeExampleWithMetadataClosure
`
A throwing closure executed before an example is run. The closure is given example metadata, which contains information about the example that is about to be run.
Swift
public typealias BeforeExampleWithMetadataClosure = @MainActor (_ exampleMetadata: ExampleMetadata) throws -> Void
`
BeforeExampleWithMetadataNonThrowingClosure
`
A closure executed before an example is run. The closure is given example metadata, which contains information about the example that is about to be run. This is only used by ObjC
Swift
public typealias BeforeExampleWithMetadataNonThrowingClosure = @MainActor (_ exampleMetadata: ExampleMetadata) -> Void
`
ExampleClosure
`
A closure for running an example.
Swift
public typealias ExampleClosure = @MainActor () throws -> Void
`
AfterExampleAsyncClosure
`
An async throwing closure executed after an example is run.
Swift
public typealias AfterExampleAsyncClosure = BeforeExampleAsyncClosure
`
AfterExampleClosure
`
A throwing closure executed after an example is run.
Swift
public typealias AfterExampleClosure = BeforeExampleClosure
`
AfterExampleNonThrowingClosure
`
A closure executed after an example is run. This is only used by ObjC
Swift
public typealias AfterExampleNonThrowingClosure = BeforeExampleNonThrowingClosure
`
AfterExampleWithMetadataAsyncClosure
`
An async throwing closure executed after an example is run. The closure is given example metadata, which contains information about the example that has just finished running.
Swift
public typealias AfterExampleWithMetadataAsyncClosure = BeforeExampleWithMetadataAsyncClosure
`
AfterExampleWithMetadataClosure
`
A throwing closure executed after an example is run. The closure is given example metadata, which contains information about the example that has just finished running.
Swift
public typealias AfterExampleWithMetadataClosure = BeforeExampleWithMetadataClosure
`
AfterExampleWithMetadataNonThrowingClosure
`
A closure executed after an example is run. The closure is given example metadata, which contains information about the example that has just finished running.
Swift
public typealias AfterExampleWithMetadataNonThrowingClosure = BeforeExampleWithMetadataNonThrowingClosure
`
AroundExampleClosure
`
A throwing closure which wraps an example. The closure must call runExample() exactly once.
Swift
public typealias AroundExampleClosure = @MainActor (_ runExample: @escaping () -> Void) throws -> Void
`
AroundExampleNonThrowingClosure
`
A closure which wraps an example. The closure must call runExample() exactly once.
Swift
public typealias AroundExampleNonThrowingClosure = @MainActor (_ runExample: @escaping () -> Void) -> Void
`
AroundExampleWithMetadataClosure
`
A throwing closure which wraps an example. The closure is given example metadata, which contains information about the example that the wrapper will run. The closure must call runExample() exactly once.
Swift
public typealias AroundExampleWithMetadataClosure =
@MainActor (_ exampleMetadata: ExampleMetadata, _ runExample: @escaping () -> Void) throws -> Void
`
AroundExampleWithMetadataNonThrowingClosure
`
A throwing closure which wraps an example. The closure is given example metadata, which contains information about the example that the wrapper will run. The closure must call runExample() exactly once.
Swift
public typealias AroundExampleWithMetadataNonThrowingClosure =
@MainActor (_ exampleMetadata: ExampleMetadata, _ runExample: @escaping () -> Void) -> Void
`
AroundExampleAsyncClosure
` Asynchronous
An async throwing closure which wraps an example. The closure must call runExample() exactly once.
Swift
public typealias AroundExampleAsyncClosure = (_ runExample: @escaping () async -> Void) async throws -> Void
`
AroundExampleWithMetadataAsyncClosure
` Asynchronous
An async throwing closure which wraps an example. The closure is given example metadata, which contains information about the example that the wrapper will run. The closure must call runExample() exactly once.
Swift
public typealias AroundExampleWithMetadataAsyncClosure =
(_ exampleMetadata: ExampleMetadata, _ runExample: @escaping () async -> Void) async throws -> Void
`
BeforeSuiteAsyncClosure
` Asynchronous
An async throwing closure executed before any examples are run.
Swift
public typealias BeforeSuiteAsyncClosure = () async throws -> Void
`
BeforeSuiteClosure
`
A throwing closure executed before any examples are run.
Swift
public typealias BeforeSuiteClosure = @MainActor () throws -> Void
`
BeforeSuiteNonThrowingClosure
`
A closure executed before any examples are run.
Swift
public typealias BeforeSuiteNonThrowingClosure = @MainActor () -> Void
`
AfterSuiteAsyncClosure
`
An async throwing closure executed after all examples have finished running.
Swift
public typealias AfterSuiteAsyncClosure = BeforeSuiteAsyncClosure
`
AfterSuiteClosure
`
A throwing closure executed after all examples have finished running.
Swift
public typealias AfterSuiteClosure = BeforeSuiteClosure
`
AfterSuiteNonThrowingClosure
`
A closure executed after all examples have finished running.
Swift
public typealias AfterSuiteNonThrowingClosure = BeforeSuiteNonThrowingClosure
`
SharedExampleContext
`
A closure that, when evaluated, returns a dictionary of key-value pairs that can be accessed from within a group of shared examples.
Swift
public typealias SharedExampleContext = () -> [String : Any]
`
SharedExampleClosure
`
A closure that is used to define a group of shared examples. This closure may contain any number of example and example groups.
Swift
public typealias SharedExampleClosure = (@escaping SharedExampleContext) -> Void
© 2025 Quick Contributors. All rights reserved. (Last updated: 2025-06-26)
Generated by jazzy ♪♫ v0.15.3, a Realm project.