CapyKit/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md

39 lines
935 B
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Compress Method
Compresses a given object using the `gzip` algorithm.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
public static byte[] Compress(
Object obj
)
```
**F#**
``` F#
static member Compress :
obj : Object -> byte[]
```
#### 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.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]
A byte array representing the compressed object in `gzip` format.
## See Also
#### Reference
<a href="T_CapyKit_Helpers_CompressionHelper">CompressionHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a>