Skip to content

Commit

Permalink
chore: Updating docs for .
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Dec 6, 2024
1 parent 4fcc682 commit c1d2bf3
Show file tree
Hide file tree
Showing 74 changed files with 23,427 additions and 0 deletions.
9 changes: 9 additions & 0 deletions LaunchDarkly-AesonCompat.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title>LaunchDarkly.AesonCompat</title><link href="linuwial.css" rel="stylesheet" type="text/css" title="Linuwial" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { processClass: "mathjax", ignoreClass: ".*" } });</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><span class="caption">launchdarkly-server-sdk-4.4.0: Server-side SDK for integrating with LaunchDarkly</span><ul class="links" id="page-menu"><li><a href="src/LaunchDarkly.AesonCompat.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">LaunchDarkly.AesonCompat</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>The LaunchDarkly SDK supports a subset of Aeson 1.x and 2.x. These two
versions differ in their type signatures, but are otherwise largely
compatible. To support both versions, we provide this compatibility module.</p><p>Depending on the version of Aeson you have installed, this module will
expose a KeyMap type that is either</p><ul><li>In the case of 1.x, a HashMap T.Text, or</li><li>In the case of 2.x, the new KeyMap type</li></ul><p>The compatibility layer exposes common map operations that the SDK needs and
may prove useful to customers. In nearly all instances, these are simple
aliases for the underlying Aeson equivalents.</p><p>The Aeson 2.x KeyMap is keyed by a new Key type that does not exist in 1.x.
To keep the API as consistent as possible, all functions requiring a key
will provide a Text value. In the 2.x compatibility layer, we will convert
it to a from the appropriate Key type as necessary.</p></div></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:KeyMap" class="def">KeyMap</a> = <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> <a href="src/LaunchDarkly.AesonCompat.html#KeyMap" class="link">Source</a> <a href="#t:KeyMap" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:null" class="def">null</a> :: <a href="LaunchDarkly-AesonCompat.html#t:KeyMap" title="LaunchDarkly.AesonCompat">KeyMap</a> v -&gt; <a href="../base-4.13.0.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="src/LaunchDarkly.AesonCompat.html#null" class="link">Source</a> <a href="#v:null" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:emptyObject" class="def">emptyObject</a> :: <a href="LaunchDarkly-AesonCompat.html#t:KeyMap" title="LaunchDarkly.AesonCompat">KeyMap</a> v <a href="src/LaunchDarkly.AesonCompat.html#emptyObject" class="link">Source</a> <a href="#v:emptyObject" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:singleton" class="def">singleton</a> :: <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; v -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v <a href="src/LaunchDarkly.AesonCompat.html#singleton" class="link">Source</a> <a href="#v:singleton" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:fromList" class="def">fromList</a> :: [(<a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a>, v)] -&gt; <a href="LaunchDarkly-AesonCompat.html#t:KeyMap" title="LaunchDarkly.AesonCompat">KeyMap</a> v <a href="src/LaunchDarkly.AesonCompat.html#fromList" class="link">Source</a> <a href="#v:fromList" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:toList" class="def">toList</a> :: <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v -&gt; [(<a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a>, v)] <a href="src/LaunchDarkly.AesonCompat.html#toList" class="link">Source</a> <a href="#v:toList" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:deleteKey" class="def">deleteKey</a> :: <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v <a href="src/LaunchDarkly.AesonCompat.html#deleteKey" class="link">Source</a> <a href="#v:deleteKey" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:lookupKey" class="def">lookupKey</a> :: <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v -&gt; <a href="../base-4.13.0.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> v <a href="src/LaunchDarkly.AesonCompat.html#lookupKey" class="link">Source</a> <a href="#v:lookupKey" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:objectKeys" class="def">objectKeys</a> :: <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v -&gt; [<a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a>] <a href="src/LaunchDarkly.AesonCompat.html#objectKeys" class="link">Source</a> <a href="#v:objectKeys" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:objectValues" class="def">objectValues</a> :: <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v -&gt; [v] <a href="src/LaunchDarkly.AesonCompat.html#objectValues" class="link">Source</a> <a href="#v:objectValues" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:keyToText" class="def">keyToText</a> :: <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> <a href="src/LaunchDarkly.AesonCompat.html#keyToText" class="link">Source</a> <a href="#v:keyToText" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:insertKey" class="def">insertKey</a> :: <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; v -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v <a href="src/LaunchDarkly.AesonCompat.html#insertKey" class="link">Source</a> <a href="#v:insertKey" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:filterKeys" class="def">filterKeys</a> :: (<a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; <a href="../base-4.13.0.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a>) -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> a -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> a <a href="src/LaunchDarkly.AesonCompat.html#filterKeys" class="link">Source</a> <a href="#v:filterKeys" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:filterObject" class="def">filterObject</a> :: (v -&gt; <a href="../base-4.13.0.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a>) -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v <a href="src/LaunchDarkly.AesonCompat.html#filterObject" class="link">Source</a> <a href="#v:filterObject" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:adjustKey" class="def">adjustKey</a> :: (v -&gt; v) -&gt; <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v <a href="src/LaunchDarkly.AesonCompat.html#adjustKey" class="link">Source</a> <a href="#v:adjustKey" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:mapValues" class="def">mapValues</a> :: (v1 -&gt; v2) -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v1 -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v2 <a href="src/LaunchDarkly.AesonCompat.html#mapValues" class="link">Source</a> <a href="#v:mapValues" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:mapWithKey" class="def">mapWithKey</a> :: (<a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; v1 -&gt; v2) -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v1 -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v2 <a href="src/LaunchDarkly.AesonCompat.html#mapWithKey" class="link">Source</a> <a href="#v:mapWithKey" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:mapMaybeValues" class="def">mapMaybeValues</a> :: (v1 -&gt; <a href="../base-4.13.0.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> v2) -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v1 -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v2 <a href="src/LaunchDarkly.AesonCompat.html#mapMaybeValues" class="link">Source</a> <a href="#v:mapMaybeValues" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:keyMapUnion" class="def">keyMapUnion</a> :: <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v <a href="src/LaunchDarkly.AesonCompat.html#keyMapUnion" class="link">Source</a> <a href="#v:keyMapUnion" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:foldrWithKey" class="def">foldrWithKey</a> :: (<a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; v -&gt; a -&gt; a) -&gt; a -&gt; <a href="../unordered-containers-0.2.10.0/Data-HashMap-Strict.html#t:HashMap" title="Data.HashMap.Strict">HashMap</a> <a href="../text-1.2.4.0/Data-Text.html#t:Text" title="Data.Text">Text</a> v -&gt; a <a href="src/LaunchDarkly.AesonCompat.html#foldrWithKey" class="link">Source</a> <a href="#v:foldrWithKey" class="selflink">#</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.23.0</p></div></body></html>
Loading

0 comments on commit c1d2bf3

Please sign in to comment.