Pulse

https://kean-docs.github.io/pulse/documentation/
Admin
Pulse is a logger and network inspector for Apple platforms, providing tools for logging, network...
Tokens:91,167
Snippets:1,138
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### download(resumeFrom:delegate:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/urlsessionprotocol/download%28resumefrom%3Adelegate%3A%29

This method starts a download task. It can resume a previously interrupted download if `resumeData` is provided. The `delegate` can be used to observe the download's progress and completion.

```APIDOC
## download(resumeFrom:delegate:)

### Description
Starts a download task, optionally resuming from provided `resumeData`. A delegate can be provided to handle task events.

### Method
`async throws`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **resumeData** (Data) - Required - Data representing the state of a previously suspended download task.
- **delegate** ((any URLSessionTaskDelegate)?) - Optional - A delegate object that receives messages from the session and task, such as progress updates and completion notifications.

### Returns
- **(URL, URLResponse)** - A tuple containing the final location of the downloaded file and the server's response.

### Request Example
```swift
// Assuming you have resumeData and a delegate configured
let (downloadedURL, response) = try await session.download(resumeFrom: resumeData, delegate: myDelegate)
```

### Response
#### Success Response
- **URL** (URL) - The local URL of the downloaded file.
- **URLResponse** (URLResponse) - The URL response received from the server.

#### Response Example
```swift
// Example successful response tuple
// (URL(fileURLWithPath: "/path/to/downloaded/file.dat"), HTTPURLResponse(url: ..., statusCode: 200, ...))
```
```

--------------------------------

### Configuring the Shared NetworkLogger

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/shared

Example of creating a new NetworkLogger instance with custom configuration and setting it as the shared logger. This is typically done at app launch.

```swift
NetworkLogger.shared = NetworkLogger {
    $0.excludedHosts = ["github.com"]
}
```

--------------------------------

### enable()

Source: https://kean-docs.github.io/pulse/documentation/pulse/remotelogger/enable%28%29

Enables remote logging. The logger will start searching for available servers.

```APIDOC
## enable()

### Description
Enables remote logging. The logger will start searching for available servers.

### Method
func

### Endpoint
RemoteLogger.enable()

### Parameters
None

### Response
None
```

--------------------------------

### upload(for:fromFile:delegate:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/urlsessionprotocol/upload%28for%3Afromfile%3Adelegate%3A%29

This method starts an upload task. It takes a URLRequest to specify the destination and parameters, a URL to the local file to be uploaded, and an optional delegate to handle task-specific events. The method returns the uploaded data and the server's response asynchronously, and it can throw errors.

```APIDOC
## upload(for:fromFile:delegate:)

### Description
Initiates an upload task for a given URL request, reading data from a specified file. This method is part of the `URLSessionProtocol` and is designed for asynchronous file uploads.

### Method Signature
```swift
func upload(
    for request: URLRequest,
    fromFile fileURL: URL,
    delegate: (any URLSessionTaskDelegate)?
) async throws -> (Data, URLResponse)
```

### Parameters

*   **request** (`URLRequest`) - Required - The URL request defining the destination and other properties for the upload.
*   **fileURL** (`URL`) - Required - The URL of the local file to be uploaded.
*   **delegate** (`URLSessionTaskDelegate?`) - Optional - An object conforming to `URLSessionTaskDelegate` that receives delegate messages for the task. Can be `nil`.

### Returns

*   A tuple containing `Data` (the response body) and `URLResponse` (the server's response).

### Throws

*   This method can throw errors if the upload fails.
```

--------------------------------

### secureConnectionStartDate

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/transactiontiminginfo/secureconnectionstartdate

Represents the start date of a secure connection. This is an optional Date property.

```APIDOC
## secureConnectionStartDate

### Description

This property indicates the date when a secure connection was initiated. It is an optional value, meaning it may or may not be present.

### Property

- **secureConnectionStartDate** (Date?) - An optional Date object representing the start time of the secure connection.
```

--------------------------------

### LoggerStore Initializers

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore

Provides methods to get the shared instance of LoggerStore or initialize a new store with specific URL, options, and configuration.

```APIDOC
## Initializers

`static var shared: LoggerStore`
Returns the shared store.

`init(storeURL: URL, options: Options, configuration: Configuration) throws`
Initializes the store with the given URL. The store needs to be
```

--------------------------------

### Enable Remote Logging

Source: https://kean-docs.github.io/pulse/documentation/pulse/remotelogger/enable%28%29

Call this method to start the logger searching for available servers. It must be called on the main actor.

```swift
@MainActor
func enable()

```

--------------------------------

### Enable Remote Logging

Source: https://kean-docs.github.io/pulse/documentation/pulse/remotelogger

Enables remote logging. The logger will start searching for available servers.

```swift
func enable()
```

--------------------------------

### Configure LoggerStore Size Limit

Source: https://kean-docs.github.io/pulse/documentation/pulse/nextsteps

Set the maximum size for the LoggerStore to manage disk space. This example sets the limit to 512MB.

```swift
LoggerStore.shared.configuration.sizeLimit = 512 * 1_000_000  

```

--------------------------------

### Enable Automatic MockingURLProtocol Registration

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogging-article

Use MockingURLProtocol.enableAutomaticRegistration() for a simpler setup to automatically integrate Pulse's network debugging features.

```swift
MockingURLProtocol.enableAutomaticRegistration()
```

--------------------------------

### willHandleEvent

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/configuration-swift.struct/willhandleevent

Gets called when the store receives an event. You can use it to modify the event before it is stored in order, for example, filter out some sensitive information. If you return `nil`, the event is ignored completely.

```APIDOC
## willHandleEvent

### Description
Gets called when the store receives an event. You can use it to modify the event before it is stored in order, for example, filter out some sensitive information. If you return `nil`, the event is ignored completely.

### Property Signature
```swift
var willHandleEvent: (Event) -> Event?
```

### Parameters
This property takes a closure as its value. The closure accepts one argument:
- **event** (Event) - The event received by the store.

### Return Value
The closure should return an `Event?`. 
- If an `Event` is returned, it will be stored.
- If `nil` is returned, the event will be ignored.
```

--------------------------------

### init(_:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/decodingerror/codingkey/init%28_%3A%29

Initializes a new instance of CodingKey with the provided Swift.CodingKey.

```APIDOC
## init(_:)

### Description
Initializes a new instance of CodingKey with the provided Swift.CodingKey.

### Method
`init(_ key: Swift.CodingKey)`

### Parameters
#### Path Parameters
- **key** (Swift.CodingKey) - Description not available
```

--------------------------------

### Get Server Passcode

Source: https://kean-docs.github.io/pulse/documentation/pulse/remotelogger

Returns the passcode for the server with the given name.

```swift
func getPasscode(forServerNamed: String) -> String?
```

--------------------------------

### init(storeURL:options:configuration:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/init%28storeurl%3Aoptions%3Aconfiguration%3A%29

Initializes the store with the given URL. The store needs to be configured with a URL pointing to a package containing a Pulse database. Default options and configuration are provided but can be customized.

```APIDOC
## init(storeURL:options:configuration:)

### Description
Initializes the store with the given URL. The store needs to be configured with a URL pointing to a package containing a Pulse database. Default options and configuration are provided but can be customized.

### Method
`init` (Initializer)

### Parameters
#### Parameters
- **storeURL** (URL) - Required - The store URL that points to a package (directory) with a Pulse database.
- **options** (Options) - Optional - By default, contains `create` and `sweep` options. Defaults to `[.create, .sweep]`.
- **configuration** (Configuration) - Optional - The store configuration specifying size limit, etc. Defaults to `.init()`.

### Discussion
The `shared` store is a package optimized for writing. When you are ready to share the store, create a Pulse document using `export(to:options:)` method. The document format is optimized to use the least amount of space possible.

### See Also
- `static var shared: LoggerStore`
- `struct Options`
- `struct Configuration`
```

--------------------------------

### startLoading()

Source: https://kean-docs.github.io/pulse/documentation/pulse/mockingurlprotocol/startloading%28%29

Initiates the loading process for the MockingURLProtocol. This method is intended to be overridden by subclasses to provide custom loading behavior.

```APIDOC
## startLoading()

### Description
Initiates the loading process for the MockingURLProtocol. This method is intended to be overridden by subclasses to provide custom loading behavior.

### Method
`override func startLoading()`

### Parameters
This method does not accept any parameters.

### Response
This method does not return a value directly. Its effect is to start the loading process.
```

--------------------------------

### Get NetworkTaskEntity Type

Source: https://kean-docs.github.io/pulse/documentation/pulse/networktaskentity/type

Accesses the task type of a NetworkTaskEntity. This property is read-only.

```swift
var type: NetworkLogger.TaskType? { get }
```

--------------------------------

### init(store:configuration:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/init%28store%3Aconfiguration%3A%29

Initializes the network logger. You can optionally provide a LoggerStore and a Configuration.

```APIDOC
## init(store:configuration:)

### Description
Initializes the network logger. You can optionally provide a LoggerStore and a Configuration.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **store** (LoggerStore?) - The target store for network requests.
- **configuration** (Configuration) - The store configuration.
```

--------------------------------

### startLoading() Method Signature

Source: https://kean-docs.github.io/pulse/documentation/pulse/mockingurlprotocol/startloading%28%29

This is the method signature for startLoading(). It is an override method used to begin the loading process.

```swift
override func startLoading()

```

--------------------------------

### localAddress Property Declaration

Source: https://kean-docs.github.io/pulse/documentation/pulse/networktransactionmetricsentity/localaddress

This is the Objective-C declaration for the localAddress property. It is an optional String that can be get and set.

```objectivec
@NSManaged
var localAddress: String? { get set }
```

--------------------------------

### taskDescription Property Declaration

Source: https://kean-docs.github.io/pulse/documentation/pulse/networktaskentity/taskdescription

This is the Objective-C declaration for the taskDescription property. It is an optional String that can be get and set.

```objective-c
@NSManaged
var taskDescription: String? { get set }
```

--------------------------------

### init(_:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/request/options-swift.struct/init%28_%3A%29

Initializes the NetworkLogger.Request.Options with a sequence of elements. This initializer is inherited from SetAlgebra.

```APIDOC
## init(_:)

### Description
Initializes a new instance of `NetworkLogger.Request.Options` with elements from a given sequence.

### Method
Initializer

### Parameters
#### Generic Parameters
- **S**: A type that conforms to the `Sequence` protocol.

#### Parameters
- **sequence** (S) - A sequence whose elements will be used to initialize the set.

### Constraints
- `S` must conform to `Sequence`.
- `Self.Element` must be the same type as `S.Element`.
```

--------------------------------

### init(predicate:sessions:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/exportoptions/init%28predicate%3Asessions%3A%29

Initializes the store with the given options. The predicate filters the data, and sessions can be used to specify a subset of sessions to export.

```APIDOC
## init(predicate:sessions:)

### Description
Initializes the store with the given options. This method allows for filtering data using an NSPredicate and specifying a set of sessions for export.

### Method
Initializer

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

### Parameters
- **predicate** (NSPredicate?) - Optional - A predicate to filter the data.
- **sessions** (Set<UUID>?) - Optional - A set of session UUIDs to export.
```

--------------------------------

### httpShouldHandleCookies Property Declaration

Source: https://kean-docs.github.io/pulse/documentation/pulse/networkrequestentity/httpshouldhandlecookies

This is the Objective-C declaration for the httpShouldHandleCookies property. It is an NSManaged property that can be get and set.

```objc
@NSManaged
var httpShouldHandleCookies: Bool { get set }
```

--------------------------------

### init(sizeLimit:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/configuration-swift.struct/init%28sizelimit%3A%29

Initializes the LoggerStore configuration with an optional size limit for the logger store, including database and blobs. Defaults to 256MB.

```APIDOC
## init(sizeLimit:)

### Description
Initializes the configuration for the LoggerStore.

### Parameters
#### Parameters
- **sizeLimit** (Int64) - Optional - The approximate limit of the logger store, including both the database and the blobs. Defaults to 256 * 1_000_000 bytes (256MB).
```

--------------------------------

### init<S>(_ sequence: S)

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/options-swift.struct/init%28_%3A%29

Initializes a new `LoggerStore.Options` instance by taking a sequence of elements. This initializer is inherited from `SetAlgebra` and requires that the sequence's element type matches the `Element` type of `LoggerStore.Options`.

```APIDOC
## init<S>(_ sequence: S)

### Description
Initializes a new `LoggerStore.Options` instance by taking a sequence of elements. This initializer is inherited from `SetAlgebra` and requires that the sequence's element type matches the `Element` type of `LoggerStore.Options`.

### Method
Initializer

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
An initialized `LoggerStore.Options` instance.

#### Response Example
None
```

--------------------------------

### knownServers Property Declaration

Source: https://kean-docs.github.io/pulse/documentation/pulse/remotelogger/knownservers

This is the declaration of the `knownServers` property. It is a published, main actor-bound variable that can be get and set.

```swift
@Published @MainActor
var knownServers: [String] { get set }
```

--------------------------------

### init()

Source: https://kean-docs.github.io/pulse/documentation/pulse/urlsessionproxy/options/init%28%29

Creates default options for URLSessionProxy.

```APIDOC
## init()

### Description
Creates default options for URLSessionProxy.

### Method
init()

### Endpoint
N/A (Initializes an object)

### Parameters
None

### Request Example
```swift
let options = URLSessionProxy.Options()
```

### Response
Initializes an instance of URLSessionProxy.Options with default values.
```

--------------------------------

### responseContentType Property Declaration

Source: https://kean-docs.github.io/pulse/documentation/pulse/networktaskentity/responsecontenttype

This is the Objective-C declaration for the responseContentType instance property. It is an optional String that can be get and set.

```objective-c
@NSManaged
var responseContentType: String? { get set }
```

--------------------------------

### LoggerStore.Level ...(_:) Operator Definition

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/level/%27...%28_%3A%29-9lcqm

The operator creates a partial range starting from the specified minimum value.

```Swift
static func ... (minimum: Self) -> PartialRangeFrom<Self>
```

--------------------------------

### init(_:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/request/init%28_%3A%29

Initializes a new NetworkLogger.Request instance with the provided URLRequest.

```APIDOC
## init(_:)

### Description
Initializes a new NetworkLogger.Request instance with the provided URLRequest.

### Method
initializer

### Parameters
#### Path Parameters
- **urlRequest** (URLRequest) - Description: The URLRequest to initialize the NetworkLogger.Request with.
```

--------------------------------

### init(string:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/version-swift.struct/init%28string%3A%29

Initializes a LoggerStore.Version object from a string. This operation can throw an error, indicating a potential issue during initialization.

```APIDOC
## init(string:)

### Description
Initializes a new instance of LoggerStore.Version with a string representation. This method can throw an error if the provided string is invalid or cannot be processed.

### Method
`init` (Initializer)

### Parameters
#### Initializer Parameters
- **string** (String) - Required - The string representation to initialize the LoggerStore.Version with.

### Throws
An error may be thrown if the initialization fails due to an invalid or malformed input string.
```

--------------------------------

### domainLookupStartDate Property Declaration

Source: https://kean-docs.github.io/pulse/documentation/pulse/networktransactionmetricsentity/domainlookupstartdate

This is the Objective-C declaration for the domainLookupStartDate instance property. It is an optional Date object that can be get and set.

```objective-c
@NSManaged
var domainLookupStartDate: Date? { get set }
```

--------------------------------

### Get View Context

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/backgroundcontext

Retrieve the view context for accessing entities on the main thread. Use this for UI-related operations.

```swift
var viewContext: NSManagedObjectContext
```

--------------------------------

### init(from:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/request/options-swift.struct/init%28from%3A%29

Initializes `NetworkLogger.Request.Options` from a decoder. This initializer is available when `Self` conforms to `Decodable` and its `RawValue` is `Int8`.

```APIDOC
## init(from:)

### Description
Initializes `NetworkLogger.Request.Options` from a decoder. This initializer is inherited from `RawRepresentable.init(from:)`.

### Signature
```swift
init(from decoder: any Decoder) throws
```

### Availability
Available when `Self` conforms to `Decodable` and `RawValue` is `Int8`.
```

--------------------------------

### isReusedConnection Property Declaration

Source: https://kean-docs.github.io/pulse/documentation/pulse/networktransactionmetricsentity/isreusedconnection

This is the Objective-C declaration for the isReusedConnection property. It is an instance property of type Bool with a get and set accessor.

```swift
@NSManaged
var isReusedConnection: Bool { get set }
```

--------------------------------

### Initializers

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/options-swift.struct/setalgebra-implementations

Provides details on how to initialize SetAlgebra objects.

```APIDOC
## Initializers

### `init<S>(S)`

Initializes a new SetAlgebra instance from a generic set `S`.

### `init(arrayLiteral: Self.Element...)`

Initializes a new SetAlgebra instance using an array literal.
```

--------------------------------

### LoggerStore.Level.name Property Declaration

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/level/name

The 'name' property of LoggerStore.Level is a read-only String. It is used to get the string representation of the log level.

```swift
var name: String { get }
```

--------------------------------

### init(codingPath:debugDescription:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/decodingerror/context-swift.struct/init%28codingpath%3Adebugdescription%3A%29

Initializes a new instance of NetworkLogger.DecodingError.Context with the specified coding path and debug description.

```APIDOC
## init(codingPath:debugDescription:)

### Description
Initializes a new instance of NetworkLogger.DecodingError.Context.

### Parameters
#### Initializer Parameters
- **codingPath** ([CodingKey]) - The coding path for the error.
- **debugDescription** (String) - A description of the decoding error.
```

--------------------------------

### Get Blob Data by Key

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/getblobdata%28forkey%3A%29

Retrieves data associated with a given key from the LoggerStore. Returns nil if the key is not found.

```swift
func getBlobData(forKey key: String) -> Data?
```

--------------------------------

### connect(to:passcode:_:) Method

Source: https://kean-docs.github.io/pulse/documentation/pulse/remotelogger/connect%28to%3Apasscode%3A_%3A%29

Establishes a connection to a selected server. Upon successful connection, the server is added to the list of known servers and the provided passcode is stored securely in the keychain.

```APIDOC
## connect(to:passcode:_:) 

### Description
Connects to the selected server. If the connection is successful, the server is saved to the list of “known” servers and the passcode is stored in the keychain.

### Method Signature
```swift
@MainActor
func connect(
    to server: NWBrowser.Result,
    passcode: String? = nil,
    _ completion: ((Result<Void, ConnectionError>) -> Void)? = nil
)
```

### Parameters
#### Path Parameters
- **server** (NWBrowser.Result) - Required - The server to connect to.
- **passcode** (String?) - Optional - The passcode for the connection.

#### Completion Handler
- **completion** ((Result<Void, ConnectionError>) -> Void)? - An optional completion handler that is called with the result of the connection attempt. The result is either `Void` on success or a `ConnectionError` on failure.
```

--------------------------------

### SetAlgebra Implementations

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/request/options-swift.struct/setalgebra-implementations

Provides details on how to use SetAlgebra implementations, including initializers, properties, and methods.

```APIDOC
## SetAlgebra Implementations

### Topics

#### Initializers

- `init<S>(S)`: Initializes a new SetAlgebra instance with elements from another SetAlgebra.
- `init(arrayLiteral: Self.Element...)`: Initializes a new SetAlgebra instance from an array literal.

### Instance Properties

- `var isEmpty: Bool`: A boolean value indicating whether the SetAlgebra is empty.

### Instance Methods

- `func isDisjoint(with: Self) -> Bool`: Checks if the current SetAlgebra is disjoint with another SetAlgebra.
- `func isStrictSubset(of: Self) -> Bool`: Checks if the current SetAlgebra is a strict subset of another SetAlgebra.
- `func isStrictSuperset(of: Self) -> Bool`: Checks if the current SetAlgebra is a strict superset of another SetAlgebra.
- `func isSubset(of: Self) -> Bool`: Checks if the current SetAlgebra is a subset of another SetAlgebra.
- `func isSuperset(of: Self) -> Bool`: Checks if the current SetAlgebra is a superset of another SetAlgebra.
- `func subtract(Self)`: Removes elements from the current SetAlgebra that are also present in another SetAlgebra.
- `func subtracting(Self) -> Self`: Returns a new SetAlgebra with elements from the current SetAlgebra that are not present in another SetAlgebra.
```

--------------------------------

### Get Core Data Container

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/backgroundcontext

Retrieve the Core Data container associated with the store. This is often a prerequisite for accessing contexts.

```swift
let container: NSPersistentContainer
```

--------------------------------

### init(from:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/info/deviceinfo-swift.struct/init%28from%3A%29

Initializes a DeviceInfo object by decoding it from a provided Decoder. This method is inherited from the Decodable protocol.

```APIDOC
## init(from:)

### Description
Initializes a DeviceInfo object by decoding it from a provided Decoder. This method is inherited from the Decodable protocol.

### Method
`init(from: any Decoder) throws`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
Initializes a DeviceInfo object.

#### Response Example
None
```

--------------------------------

### OptionSet Implementations

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/request/options-swift.struct/optionset-implementations

Provides details on the available initializers and instance methods for the OptionSet type, allowing users to manage request options effectively.

```APIDOC
## OptionSet Implementations

### Initializers

`init()`

### Instance Methods

`func contains(Self) -> Bool`

`func formIntersection(Self)`

`func formSymmetricDifference(Self)`

`func formUnion(Self)`

`func insert(Self.Element) -> (inserted: Bool, memberAfterInsert: Self.Element)`

`func intersection(Self) -> Self`

`func remove(Self.Element) -> Self.Element?`

`func symmetricDifference(Self) -> Self`

`func union(Self) -> Self`

`func update(with: Self.Element) -> Self.Element?`
```

--------------------------------

### Get Current Store Info

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/info%28%29

Call this method to retrieve the current state and information of the LoggerStore. It is thread-safe but should not be invoked within the backgroundContext queue.

```swift
func info() async throws -> Info
```

--------------------------------

### export(to:options:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/export%28to%3Aoptions%3A%29

Creates a copy of the current store at the given URL. The created copy has `.pulse` extension. The destination directory must already exist. If the file at the destination URL already exists, an error is thrown.

```APIDOC
## export(to:options:)

### Description
Creates a copy of the current store at the given URL. The created copy has `.pulse` extension. The destination directory must already exist. If the file at the destination URL already exists, an error is thrown.

### Parameters

- **to targetURL** (URL) - Required - The destination URL for the exported store. The directory must exist.
- **options** (ExportOptions) - Optional - Specifies other sharing options for the export process.
```

--------------------------------

### Remove All Logger Messages

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/removeall%28%29

Use this method to clear all previously recorded messages from the store. No setup or imports are required beyond having an instance of the LoggerStore.

```Go
func removeAll()
```

--------------------------------

### init(_:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/response/init%28_%3A%29

Initializes a NetworkLogger.Response object using a URLResponse. This is the primary way to create a response object for logging network requests.

```APIDOC
## init(_:)

### Description
Initializes a NetworkLogger.Response object with a URLResponse.

### Method
initializer

### Parameters
#### Path Parameters
- **urlResponse** (URLResponse) - Required - The URLResponse object to initialize the NetworkLogger.Response with.
```

--------------------------------

### download(for:delegate:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/urlsessionprotocol/download%28for%3Adelegate%3A%29

Initiates a download task for a given URL request and delegate. This method is asynchronous and can throw errors.

```APIDOC
## download(for:delegate:)

### Description
Initiates a download task for a given URL request and delegate. This method is asynchronous and can throw errors.

### Method
`async throws`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **request** (URLRequest) - The URL request defining the resource to download.
- **delegate** (any URLSessionTaskDelegate)? - An optional delegate to handle task-specific events.

### Returns
- **(URL, URLResponse)** - A tuple containing the final location of the downloaded file (URL) and the server's response (URLResponse).

### Throws
- Errors encountered during the download process.
```

--------------------------------

### Integrate PulseUI ConsoleView

Source: https://kean-docs.github.io/pulse/documentation/pulse/gettingstarted

Integrate the PulseUI ConsoleView into your application to view logs and network requests. This example shows how to present it using a NavigationLink.

```swift
import PulseUI


NavigationLink(destination: ConsoleView()) {
    Text("Console")
}

```

--------------------------------

### Instance Methods

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/transactionmetrics/conditions-swift.struct/setalgebra-implementations

Details the methods available for SetAlgebra instances.

```APIDOC
## Instance Methods

### `func isDisjoint(with: Self) -> Bool`

Checks if this set is disjoint with another set.

### `func isStrictSubset(of: Self) -> Bool`

Checks if this set is a strict subset of another set.

### `func isStrictSuperset(of: Self) -> Bool`

Checks if this set is a strict superset of another set.

### `func isSubset(of: Self) -> Bool`

Checks if this set is a subset of another set.

### `func isSuperset(of: Self) -> Bool`

Checks if this set is a superset of another set.

### `func subtract(Self)`

Removes elements from this set that are also in another set.

### `func subtracting(Self) -> Self`

Returns a new set with elements from this set that are not in another set.
```

--------------------------------

### willHandleEvent

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/configuration/willhandleevent

This property is a closure that gets called when the logger receives an event. It allows you to modify the event before it's stored or filter it out entirely by returning `nil`.

```APIDOC
## willHandleEvent

### Description
Gets called when the logger receives an event. You can use it to modify the event before it is stored in order, for example, filter out some sensitive information. If you return `nil`, the event is ignored completely.

### Method
Closure assignment

### Endpoint
N/A (Instance Property)

### Parameters
#### Closure Parameter
- **event** (LoggerStore.Event) - The event received by the logger.

### Return Value
- **LoggerStore.Event?** - The modified event, or `nil` to ignore the event.
```

--------------------------------

### LoggerStore.Options.create Property

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/options-swift.struct/create

Use this static property to create a new LoggerStore.Options instance. The intermediate directories for the store's file path must already exist.

```swift
static let create: LoggerStore.Options
```

--------------------------------

### init(logger:delegate:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/urlsessionproxydelegate/init%28logger%3Adelegate%3A%29

Initializes a URLSessionProxyDelegate. You can optionally provide a NetworkLogger for custom logging and a URLSessionDelegate to handle the actual session events.

```APIDOC
## init(logger:delegate:)

### Description
Initializes a URLSessionProxyDelegate with an optional logger and an optional session delegate.

### Parameters

#### Parameters

- **logger** (NetworkLogger?) - Optional - By default, uses a shared logger.
- **delegate** (URLSessionDelegate?) - Optional - The “actual” session delegate, strongly retained.
```

--------------------------------

### data(from: URL)

Source: https://kean-docs.github.io/pulse/documentation/pulse/urlsessionproxy/urlsessionprotocol-implementations

Asynchronously fetches the entire content from a given URL as Data. This is a convenience method for simple GET requests where the entire response can fit into memory.

```APIDOC
## data(from: URL)

### Description
Asynchronously fetches the entire content from a given URL as Data. This is a convenience method for simple GET requests where the entire response can fit into memory.

### Method
`async`

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
- **from** (URL) - Required - The URL to fetch data from.

### Response
#### Success Response
- **Data** - The data received from the server.
- **URLResponse** - The response received from the server.
```

--------------------------------

### init(metrics:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/transactiontiminginfo/init%28metrics%3A%29

Initializes a new instance of TransactionTimingInfo using URLSessionTaskTransactionMetrics.

```APIDOC
## init(metrics:)

### Description
Initializes a TransactionTimingInfo object with the provided URLSessionTaskTransactionMetrics.

### Method
initializer

### Parameters
#### Path Parameters
- **metrics** (URLSessionTaskTransactionMetrics) - Required - The transaction metrics to initialize the object with.
```

--------------------------------

### Swift @NSManaged errorCode Property

Source: https://kean-docs.github.io/pulse/documentation/pulse/networktaskentity/errorcode

This snippet shows the declaration of the errorCode instance property in Swift, which is managed by @NSManaged. It is an Int32 type and has both get and set accessors.

```swift
@NSManaged
var errorCode: Int32 { get set }
```

--------------------------------

### LoggerStore Initializer

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/init%28storeurl%3Aoptions%3Aconfiguration%3A%29

Initializes the store with the given URL, options, and configuration. Use this to set up a new Pulse database package.

```swift
init(
    storeURL: URL,
    options: Options = [.create, .sweep],
    configuration: Configuration = .init()
) throws
```

--------------------------------

### httpHeaders Instance Property Declaration

Source: https://kean-docs.github.io/pulse/documentation/pulse/networkrequestentity/httpheaders

This Swift code declares the httpHeaders instance property, which is managed by @NSManaged and is of type String. It provides both a get and set accessor.

```swift
@NSManaged
var httpHeaders: String { get set }
```

--------------------------------

### Accessing the Current Log Session

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/session-swift.struct/current

Use this static property to retrieve the currently active log session. No setup or imports are required beyond the LoggerStore framework.

```swift
static let current: LoggerStore.Session
```

--------------------------------

### init(_:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/responseerror/init%28_%3A%29

Initializes a new instance of ResponseError with the specified Swift Error.

```APIDOC
## init(_:)

### Description
Initializes a new instance of `ResponseError` with the specified Swift `Error`.

### Method
`init` (Initializer)

### Parameters
#### Path Parameters
- **error** (Swift.Error) - Description: The underlying Swift error to associate with this `ResponseError`.

### Request Example
```swift
let underlyingError = NSError(domain: "com.example", code: 1001, userInfo: nil)
let responseError = NetworkLogger.ResponseError(underlyingError)
```

### Response
#### Success Response
An instance of `NetworkLogger.ResponseError` is created.

#### Response Example
```swift
// No direct response example as this is an initializer.
// The result is an instance of ResponseError.
```
```

--------------------------------

### Get Background Managed Object Context

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/backgroundcontext

Retrieve the background managed object context used for all write operations. This context is essential for performing asynchronous data modifications.

```swift
let backgroundContext: NSManagedObjectContext
```

--------------------------------

### init(from:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/level/init%28from%3A%29

Initializes a LoggerStore.Level instance from a decoder. This initializer is available when `Self` conforms to `Decodable` and its `RawValue` is `Int16`.

```APIDOC
## init(from:)

### Description
Initializes a LoggerStore.Level instance from a decoder.

### Method
Initializer

### Parameters
#### Decoder
- **decoder** (any Decoder) - The decoder to read data from.

### Availability
Available when `Self` conforms to `Decodable` and `RawValue` is `Int16`.
```

--------------------------------

### Create Custom View for Analytics Logs

Source: https://kean-docs.github.io/pulse/documentation/pulse/nextsteps

Access and display logs from LoggerStore using Core Data entities. This example fetches and lists messages with the 'analytics' label.

```swift
struct AnalyticsLogsView: View {
    @FetchRequest(
        sortDescriptors: [NSSortDescriptor(keyPath: \LoggerMessageEntity.createdAt, ascending: true)],
        predicate: NSPredicate(format: "label == %@", "analytics")
    ) var messages: FetchedResults<LoggerMessageEntity>


    var body: some View {
        List(messages, id: \.objectID) { message in
            <#view#>
        }
    }
}


```

--------------------------------

### Initialize RemoteLogger with Store

Source: https://kean-docs.github.io/pulse/documentation/pulse/remotelogger

Initializes the RemoteLogger with a LoggerStore.

```swift
func initialize(store: LoggerStore)
```

--------------------------------

### init(_:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/decodingerror/init%28_%3A%29

Initializes a DecodingError with a Swift.DecodingError.

```APIDOC
## init(_:)

### Description
Initializes a DecodingError with a Swift.DecodingError.

### Method
initializer

### Parameters
#### Path Parameters
- **error** (Swift.DecodingError) - Description: The decoding error to initialize with.
```

--------------------------------

### LoggerMessageEntity text Property Declaration

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggermessageentity/text

This Swift code declares the 'text' property for a LoggerMessageEntity. It is an Objective-C managed property that stores the message as a String and supports both getting and setting its value.

```swift
@NSManaged
var text: String { get set }
```

--------------------------------

### Get Data Closure for LoggerBlobHandleEntity

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerblobhandleentity

This static method returns a closure that can be used to fetch the entity's data. The closure can be executed on any thread, providing flexibility for data retrieval.

```swift
static func getData(for: LoggerBlobHandleEntity, store: LoggerStore) -> () -> Data?
```

--------------------------------

### init(_:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/decodingerror/context-swift.struct/init%28_%3A%29

Initializes a new instance of NetworkLogger.DecodingError.Context. This initializer takes a `Swift.DecodingError.Context` object, which contains information about the decoding process, such as thecodingPath and debugDescription.

```APIDOC
## init(_:)

### Description
Initializes a new instance of `NetworkLogger.DecodingError.Context` with the provided decoding error context.

### Parameters
#### Path Parameters
- **context** (Swift.DecodingError.Context) - Required - The context of the decoding error.
```

--------------------------------

### LoggerStore.Level.critical Case

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/level/critical

Demonstrates the case statement for LoggerStore.Level.critical.

```go
case critical
```

--------------------------------

### OptionSet Initializers

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/options-swift.struct/optionset-implementations

Details the available initializers for OptionSet types.

```APIDOC
## Initializers

### `init()`

Initializes a new instance of the OptionSet.
```

--------------------------------

### LoggerMessageEntity Session Property Declaration

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggermessageentity/session

This snippet shows the Objective-C declaration for the 'session' property within the LoggerMessageEntity. It is an instance property of type UUID, managed by @NSManaged, and supports both getting and setting its value.

```objective-c
@NSManaged
var session: UUID { get set }
```

--------------------------------

### NetworkRequestEntity Headers Property

Source: https://kean-docs.github.io/pulse/documentation/pulse/networkrequestentity/headers

Defines the 'headers' property for a NetworkRequestEntity. This property is a lazy variable that holds a dictionary of string keys and string values, representing HTTP headers. It supports both getting and setting header values.

```swift
lazy var headers: [String : String] { get set }
```

--------------------------------

### LoggerStore.Version.init(_:_:_:) Initializer

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/version-swift.struct/init%28_%3A_%3A_%3A%29

Initializes a new `Version` object with specified major, minor, and patch version numbers. This is a direct initializer for creating version instances.

```APIDOC
## init(_:_:_:) Initializer

### Description
Initializes a new `Version` object with specified major, minor, and patch version numbers.

### Method
`init`

### Parameters
#### Path Parameters
- **major** (Int) - Required - The major version number.
- **minor** (Int) - Required - The minor version number.
- **patch** (Int) - Required - The patch version number.

### Request Example
```swift
let version = LoggerStore.Version(1, 2, 3)
```

### Response
#### Success Response
- **Version** - A new instance of the `LoggerStore.Version` struct.

#### Response Example
```swift
// Example of a created Version object (internal representation)
// LoggerStore.Version(major: 1, minor: 2, patch: 3)
```
```

--------------------------------

### download(from:delegate:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/urlsessionprotocol/download%28from%3Adelegate%3A%29

Initiates an asynchronous download task. This method is part of the URLSessionProtocol and requires a URL to download from and an optional delegate to handle task-specific events.

```APIDOC
## download(from:delegate:)

### Description
Initiates an asynchronous download task. This method is part of the URLSessionProtocol and requires a URL to download from and an optional delegate to handle task-specific events.

### Method
`async throws`

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```swift
func download(
    from url: URL,
    delegate: (any URLSessionTaskDelegate)?
) async throws -> (URL, URLResponse)
```

### Response
#### Success Response
Returns a tuple containing the downloaded file's URL and the URLResponse.

- **URL** (URL) - The local URL of the downloaded file.
- **URLResponse** (URLResponse) - The response received from the server.

#### Response Example
```swift
(downloadedURL, response)
```
```

--------------------------------

### dataTask(with:completionHandler:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/urlsessionprotocol/datatask%28with%3Acompletionhandler%3A%29-4s2vp

Initiates a data task that retrieves the contents of a URL. The task is created in a suspended state; you must call `resume()` on the returned object to start the data transfer. The completion handler is called when the request completes, or after an error occurs.

```APIDOC
## dataTask(with:completionHandler:)

### Description
Creates a data task that retrieves the contents of a URL. The task is created in a suspended state; you must call `resume()` on the returned object to start the data transfer. The completion handler is called when the request completes, or after an error occurs.

### Method
`URLSessionDataTask`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **url** (URL) - The URL for which to create a data task.
* **completionHandler** (@escaping (Data?, URLResponse?, (any Error)?) -> Void) - A closure that is called when the data task completes. It receives the downloaded data, the response, and any error that occurred.

### Returns
`URLSessionDataTask` - The data task object that you use to manage the request. You must call `resume()` on this object to start the request.
```

--------------------------------

### RawRepresentable Initializers and Methods

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/level/rawrepresentable-implementations

This section covers the core components of the RawRepresentable protocol as implemented for LoggerStore.Level, including how to initialize from a decoder and how to encode to an encoder, along with hashing capabilities.

```APIDOC
## RawRepresentable Implementations

### Initializers

`init(from: any Decoder) throws`

Initializes the type from a decoder.

### Instance Properties

`var hashValue: Int`

The hash value of the type.

### Instance Methods

`func encode(to: any Encoder) throws`

Encodes the type to a given encoder.

`func hash(into: inout Hasher)`

Hashes the essential components of the type into the given hasher.
```

--------------------------------

### init(taskInterval:redirectCount:transactions:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/metrics/init%28taskinterval%3Aredirectcount%3Atransactions%3A%29

Initializes NetworkLogger.Metrics with a date interval, a redirect count, and a list of transaction metrics.

```APIDOC
## init(taskInterval:redirectCount:transactions:)

### Description
Initializes the NetworkLogger Metrics with a specified task interval, redirect count, and a list of transaction metrics.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method
Initializer

### Endpoint
None

### Parameters
* **taskInterval** (DateInterval) - Description not available.
* **redirectCount** (Int) - Description not available.
* **transactions** ([TransactionMetrics]) - Description not available.

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Connect to a Server

Source: https://kean-docs.github.io/pulse/documentation/pulse/remotelogger

Connects to the selected server. Requires the server's NWBrowser.Result, an optional passcode, and a completion handler to process the connection result.

```swift
func connect(to: NWBrowser.Result, passcode: String?, ((Result<Void, ConnectionError>) -> Void)?)
```

--------------------------------

### init(from:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/decodingerror/context-swift.struct/init%28from%3A%29

Initializes a NetworkLogger.DecodingError.Context instance from a decoder. This initializer is inherited from the Decodable protocol.

```APIDOC
## init(from:)

### Description
Initializes a NetworkLogger.DecodingError.Context instance from a decoder. This initializer is inherited from the Decodable protocol.

### Method
`init(from: any Decoder) throws`

### Parameters
#### Parameters
- **decoder** (`any Decoder`) - The decoder to read data from.

### Throws
- `Error` - Throws an error if decoding fails.
```

--------------------------------

### showDetails(for:) Instance Method Signature

Source: https://kean-docs.github.io/pulse/documentation/pulse/remotelogger/showdetails%28for%3A%29-3wcua

This is the signature for the showDetails(for:) instance method. It is marked with @MainActor, indicating it should be called on the main thread.

```swift
@MainActor
func showDetails(for task: NetworkTaskEntity)
```

--------------------------------

### var configuration: Configuration

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/configuration-swift.property

Accesses the configuration object used to initialize the LoggerStore.

```APIDOC
## var configuration: Configuration

### Description
The configuration property returns the settings with which the LoggerStore instance was initialized.

### Property Signature
`var configuration: Configuration`
```

--------------------------------

### showDetails(for:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/remotelogger/showdetails%28for%3A%29-3wcua

The `showDetails(for:)` method is an instance method that takes a `NetworkTaskEntity` as input and displays its details. It is marked with `@MainActor`, indicating it should be called on the main thread.

```APIDOC
## showDetails(for:)

### Description
Displays detailed information about a specific network task.

### Method Signature
`@MainActor func showDetails(for task: NetworkTaskEntity)`

### Parameters
#### Input Parameter
- **task** (`NetworkTaskEntity`) - Required - The network task entity for which to display details.
```

--------------------------------

### download(resumeFrom:delegate:) Signature

Source: https://kean-docs.github.io/pulse/documentation/pulse/urlsessionprotocol/download%28resumefrom%3Adelegate%3A%29

This is the signature for the download method that allows resuming a download task. It requires resume data and an optional delegate.

```swift
func download(
    resumeFrom resumeData: Data,
    delegate: (any URLSessionTaskDelegate)?
) async throws -> (URL, URLResponse)
```

--------------------------------

### canInit(with:) Method Signature

Source: https://kean-docs.github.io/pulse/documentation/pulse/mockingurlprotocol/caninit%28with%3A%29

This is the declaration of the `canInit(with:)` class method. It returns a Boolean indicating whether the protocol can initialize with the provided URL request.

```swift
override class func canInit(with request: URLRequest) -> Bool
```

--------------------------------

### init(task:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/tasktype/init%28task%3A%29

Initializes a new NetworkLogger TaskType with a given URLSessionTask.

```APIDOC
## init(task:)

### Description
Initializes a new NetworkLogger TaskType instance.

### Parameters
#### Path Parameters
- **task** (URLSessionTask) - Required - The URLSessionTask to associate with this NetworkLogger task.

### Method
Initializer

### Endpoint
N/A (This is an initializer, not an HTTP endpoint)

### Request Body
N/A

### Response
N/A (Initializers do not have explicit responses in this format)

### Request Example
```swift
let task = URLSessionTask()
let networkLoggerTask = NetworkLogger.TaskType(task: task)
```

### Response Example
N/A
```

--------------------------------

### webSocketTask(with:protocols:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/urlsessionprotocol/websockettask%28with%3Aprotocols%3A%29

Initializes a URLSessionWebSocketTask with a specified URL and an array of WebSocket subprotocols.

```APIDOC
## webSocketTask(with:protocols:)

### Description
Initializes a new WebSocket task for a given URL. This task is used to communicate with a WebSocket server, supporting the specified subprotocols.

### Method
`init`

### Parameters
#### Path Parameters
- **url** (URL) - Required - The URL for the WebSocket server.
- **protocols** ([String]) - Required - An array of strings representing the WebSocket subprotocols supported by the client.
```

--------------------------------

### initialize(store:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/remotelogger/initialize%28store%3A%29

Initializes the RemoteLogger to sync with a specified LoggerStore. The `store` parameter determines which LoggerStore will be used for synchronization. By default, it uses the shared LoggerStore.

```APIDOC
## initialize(store:)

### Description
Initializes the RemoteLogger to sync with a specified LoggerStore. The `store` parameter determines which LoggerStore will be used for synchronization. By default, it uses the shared LoggerStore.

### Method
func

### Parameters
#### Parameters
- **store** (LoggerStore) - Optional - The store to be synced with the server. By default, `shared`. Only one store can be synced at a time.
```

--------------------------------

### init(from:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/info/appinfo-swift.struct/init%28from%3A%29

Initializes an AppInfo instance by decoding it from a provided decoder. This method is inherited from the `Decodable` protocol and is used for deserializing data into an AppInfo object.

```APIDOC
## init(from:)

### Description
Initializes an AppInfo instance by decoding it from a provided decoder. This method is inherited from the `Decodable` protocol and is used for deserializing data into an AppInfo object.

### Method
`init(from: any Decoder) throws`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
Initializes an AppInfo object.

#### Response Example
None
```

--------------------------------

### LoggerStore.ExportOptions Initializer

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/exportoptions/init%28predicate%3Asessions%3A%29

Initializes the store with the given options. Use this to configure filtering and session selection for exports.

```swift
init(
    predicate: NSPredicate? = nil,
    sessions: Set<UUID>? = nil
)
```

--------------------------------

### canInit(with:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/mockingurlprotocol/caninit%28with%3A%29

Determines if the MockingURLProtocol can initialize itself with the provided URL request. This is a class method that returns a Boolean value.

```APIDOC
## canInit(with:)

### Description
Determines if the MockingURLProtocol can initialize itself with the provided URL request. This is a class method that returns a Boolean value.

### Method
`class func`

### Signature
`canInit(with request: URLRequest) -> Bool`

### Parameters
#### Path Parameters
- **request** (URLRequest) - Required - The URL request to check.
```

--------------------------------

### connectStartDate Instance Property

Source: https://kean-docs.github.io/pulse/documentation/pulse/networklogger/transactiontiminginfo/connectstartdate

This snippet details the `connectStartDate` instance property, which is of type `Date?` and indicates when a network connection began.

```APIDOC
## connectStartDate

### Description
Represents the start date of a network connection. This property is part of the `NetworkLogger.TransactionTimingInfo` and is useful for analyzing transaction timing.

### Property
- **connectStartDate** (Date?) - The date and time when the connection was established.
```

--------------------------------

### LoggerStore.Options Initializer

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/options-swift.struct/init%28_%3A%29

Initializes LoggerStore.Options from a sequence of elements. The element type of the sequence must match the element type of the LoggerStore.Options.

```swift
init<S>(_ sequence: S) where S : Sequence, Self.Element == S.Element
```

--------------------------------

### var appInfo: AppInfo

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/info/appinfo-swift.property

Retrieves information about the application that created the store.

```APIDOC
## var appInfo: AppInfo

### Description
Returns an `AppInfo` object containing metadata about the application that created the current `LoggerStore`.

### Property Signature
`var appInfo: AppInfo`

### Return Type
`AppInfo`
```

--------------------------------

### init(from:)

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/event/networktaskprogressupdated/init%28from%3A%29

This initializer is inherited from the `Decodable` protocol and is used to decode a `NetworkTaskProgressUpdated` event from a given decoder.

```APIDOC
## init(from:)

### Description
Initializes a `NetworkTaskProgressUpdated` event by decoding it from a provided `Decoder`.

### Method
`init(from: any Decoder) throws`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
An initialized `NetworkTaskProgressUpdated` object.

#### Response Example
None
```

--------------------------------

### Accessing LoggerStore options

Source: https://kean-docs.github.io/pulse/documentation/pulse/loggerstore/options-swift.property

Retrieves the configuration options used to open the store.

```swift
let options: Options
```
Tokens:
Raw