@querc/squidex-client
Version:
NodeJS client for the [Squidex](https://squidex.io/) CMS
362 lines • 17.2 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SquidexClient | @querc/squidex-client</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@querc/squidex-client</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">Globals</a>
</li>
<li>
<a href="squidexclient.html">SquidexClient</a>
</li>
</ul>
<h1>Class SquidexClient</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">SquidexClient</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="squidexclient.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="squidexclient.html#config" class="tsd-kind-icon">config</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="squidexclient.html#helpers" class="tsd-kind-icon">helpers</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="squidexclient.html#content" class="tsd-kind-icon">content</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Squidex<wbr>Client<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="squidexclientconfiguration.html" class="tsd-signature-type">SquidexClientConfiguration</a><span class="tsd-signature-symbol">></span>, httpClient<span class="tsd-signature-symbol">?: </span><a href="httpclient.html" class="tsd-signature-type">HttpClient</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="squidexclient.html" class="tsd-signature-type">SquidexClient</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in squidex-client.ts:16</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>NodeJS client for the Squidex CMS</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><p>const client = new SquidexClient({
appName: 'my-app',
clientId: 'my-app:default',
clientSecret: 'SEKRIT'
})
const posts = await client.query<BlogPostDTO>('Posts')</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="squidexclientconfiguration.html" class="tsd-signature-type">SquidexClientConfiguration</a><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> httpClient: <a href="httpclient.html" class="tsd-signature-type">HttpClient</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="squidexclient.html" class="tsd-signature-type">SquidexClient</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="config" class="tsd-anchor"></a>
<h3>config</h3>
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <a href="squidexclientconfiguration.html" class="tsd-signature-type">SquidexClientConfiguration</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in squidex-client.ts:10</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Configuration options in use by the client</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="helpers" class="tsd-anchor"></a>
<h3>helpers</h3>
<div class="tsd-signature tsd-kind-icon">helpers<span class="tsd-signature-symbol">:</span> <a href="helpers.html" class="tsd-signature-type">Helpers</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in squidex-client.ts:13</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Helper methods</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="content" class="tsd-anchor"></a>
<h3>content</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">content<span class="tsd-signature-symbol">(</span>schema<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="contentschema.html" class="tsd-signature-type">ContentSchema</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in squidex-client.ts:44</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Exposes methods for querying Squidex content for a particular schema</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>schema: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="contentschema.html" class="tsd-signature-type">ContentSchema</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../index.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="authenticationmanager.html" class="tsd-kind-icon">Authentication<wbr>Manager</a>
</li>
<li class=" tsd-kind-class">
<a href="configurationmanager.html" class="tsd-kind-icon">Configuration<wbr>Manager</a>
</li>
<li class=" tsd-kind-class">
<a href="contentschema.html" class="tsd-kind-icon">Content<wbr>Schema</a>
</li>
<li class=" tsd-kind-class">
<a href="helpers.html" class="tsd-kind-icon">Helpers</a>
</li>
<li class=" tsd-kind-class">
<a href="httpclient.html" class="tsd-kind-icon">Http<wbr>Client</a>
</li>
<li class=" tsd-kind-class">
<a href="httpsendparams.html" class="tsd-kind-icon">Http<wbr>Send<wbr>Params</a>
</li>
<li class=" tsd-kind-class">
<a href="nodefetchclient.html" class="tsd-kind-icon">Node<wbr>Fetch<wbr>Client</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="squidexclient.html" class="tsd-kind-icon">Squidex<wbr>Client</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="squidexclient.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="squidexclient.html#config" class="tsd-kind-icon">config</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="squidexclient.html#helpers" class="tsd-kind-icon">helpers</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="squidexclient.html#content" class="tsd-kind-icon">content</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class">
<a href="squidexclientconfiguration.html" class="tsd-kind-icon">Squidex<wbr>Client<wbr>Configuration</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="squidexcontent.html" class="tsd-kind-icon">Squidex<wbr>Content</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="squidexcontentcollection.html" class="tsd-kind-icon">Squidex<wbr>Content<wbr>Collection</a>
</li>
<li class=" tsd-kind-class">
<a href="squidexinvariant.html" class="tsd-kind-icon">Squidex<wbr>Invariant</a>
</li>
<li class=" tsd-kind-class">
<a href="squidexjsonquery.html" class="tsd-kind-icon">Squidex<wbr>Json<wbr>Query</a>
</li>
<li class=" tsd-kind-class">
<a href="squidexoauthrequest.html" class="tsd-kind-icon">SquidexOAuth<wbr>Request</a>
</li>
<li class=" tsd-kind-class">
<a href="squidexoauthresponse.html" class="tsd-kind-icon">SquidexOAuth<wbr>Response</a>
</li>
<li class=" tsd-kind-class">
<a href="squidexodataquery.html" class="tsd-kind-icon">SquidexOData<wbr>Query</a>
</li>
<li class=" tsd-kind-class">
<a href="squidexstatusupdate.html" class="tsd-kind-icon">Squidex<wbr>Status<wbr>Update</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../index.html#squidexquery" class="tsd-kind-icon">Squidex<wbr>Query</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>