mirror of
https://github.com/wagesj45/CapyKit.git
synced 2024-11-14 12:13:36 -06:00
Jordan Wages
87bd044b31
The `SettingsHelper` is an agnostic way to access settings values uniformly through code. The accessor methods are controlled by the consumer. Documentation has been a bit wonky. I changed the max number of version number components allowed, so each new build should not create new changes on every single bit of documentation now.
38 lines
920 B
Markdown
38 lines
920 B
Markdown
# CompressToString Method
|
||
|
||
|
||
Compresses a given object to a string using `base64` encoding of `gzip` format.
|
||
|
||
|
||
|
||
## Definition
|
||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||
|
||
**C#**
|
||
``` C#
|
||
public static string CompressToString(
|
||
Object obj
|
||
)
|
||
```
|
||
**F#**
|
||
``` F#
|
||
static member CompressToString :
|
||
obj : Object -> string
|
||
```
|
||
|
||
|
||
|
||
#### Parameters
|
||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a></dt><dd>The object.</dd></dl>
|
||
|
||
#### Return Value
|
||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
||
A string in `base64` encoding.
|
||
|
||
## See Also
|
||
|
||
|
||
#### Reference
|
||
<a href="T_CapyKit_Helpers_CompressionHelper.md">CompressionHelper Class</a>
|
||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|