@graphistry/js-upload-api
Version:
Graphistry upload client for reuse by node and browser clients
44 lines • 41 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NodeFile | @graphistry/node-api - v5.1.3</title><meta name="description" content="Documentation for @graphistry/node-api - v5.1.3"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@graphistry/node-api - v5.1.3</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><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</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="../modules.html">@graphistry/node-api - v5.1.3</a></li><li><a href="NodeFile.html">NodeFile</a></li></ul><h1>Class NodeFile </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Helper class for tracking intent when creating a <a href="File.html">File</a> object for uploading</p>
</div><div><p>See examples at top of file</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="File.html" class="tsd-signature-type" data-tsd-kind="Class">File</a><ul class="tsd-hierarchy"><li><span class="target">NodeFile</span></li></ul></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 tsd-is-overwrite"><a href="NodeFile.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#createFile" class="tsd-kind-icon">create<wbr/>File</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#setData" class="tsd-kind-icon">set<wbr/>Data</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#upload" class="tsd-kind-icon">upload</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#uploadData" class="tsd-kind-icon">upload<wbr/>Data</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#createOpts" class="tsd-kind-icon">create<wbr/>Opts</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileFormat" class="tsd-kind-icon">file<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#uploadUrlOpts" class="tsd-kind-icon">upload<wbr/>Url<wbr/>Opts</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileCreateResponse" class="tsd-kind-icon">file<wbr/>Create<wbr/>Response</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileCreated" class="tsd-kind-icon">file<wbr/>Created</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileID" class="tsd-kind-icon">fileID</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileUploadResponse" class="tsd-kind-icon">file<wbr/>Upload<wbr/>Response</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileUploaded" class="tsd-kind-icon">file<wbr/>Uploaded</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileValidated" class="tsd-kind-icon">file<wbr/>Validated</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 tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Node<wbr/>File<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, fileFormat<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, createOpts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span>, urlOpts<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="NodeFile.html" class="tsd-signature-type" data-tsd-kind="Class">NodeFile</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="File.html">File</a>.<a href="File.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L354">File.ts:354</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>See examples at top of file</p>
</div><div><p>Create a new <a href="File.html">File</a> object for uploading or use with <a href="Dataset.html">Dataset</a></p>
<p>For more information on the available options, see:</p>
<ul>
<li>Creation step metadata options: <a href="https://hub.graphistry.com/docs/api/2/rest/files/">https://hub.graphistry.com/docs/api/2/rest/files/</a></li>
<li>Upload step options: <a href="https://hub.graphistry.com/docs/api/2/rest/files/#uploadfiledata">https://hub.graphistry.com/docs/api/2/rest/files/#uploadfiledata</a></li>
</ul>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = undefined</span></h5></li><li><h5>fileFormat: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'json'</span></h5></li><li><h5>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'my file'</span></h5></li><li><h5>createOpts: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></h5><ul class="tsd-parameters"></ul></li><li><h5>urlOpts: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ''</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="NodeFile.html" class="tsd-signature-type" data-tsd-kind="Class">NodeFile</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="createFile" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>File<a href="#createFile" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">create<wbr/>File<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a>, force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="File.html">File</a>.<a href="File.html#createFile">createFile</a></p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L245">File.ts:245</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>See examples at top of file</p>
</div><div><p>Helper function to create the file on the server but not yet upload its data</p>
<p>By default, this will skip recreating files that have already been created.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p><a href="Client.html">Client</a> object to use for uploading</p>
</div></div></li><li><h5>force: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>If true, will force creation of a new ID even if file has already been uploaded</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Data<a href="#setData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">set<wbr/>Data<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="File.html">File</a>.<a href="File.html#setData">setData</a></p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L306">File.ts:306</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>See examples at top of file</p>
</div><div><p>Populate data for later uploading if it wasn't set during construction</p>
<p>Cannot run this function if the file has already been uploaded</p>
<p>Overwrites any existing data</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Data to use for uploading</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="upload" class="tsd-anchor"></a><h3 class="tsd-anchor-link">upload<a href="#upload" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">upload<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a>, force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="File.html" class="tsd-signature-type" data-tsd-kind="Class">File</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="File.html">File</a>.<a href="File.html#upload">upload</a></p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L212">File.ts:212</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>See examples at top of file</p>
</div><div><p>Upload curent <a href="File.html">File</a> object to the server</p>
<p>By default, this will skip reuploading files that have already been uploaded.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p><a href="Client.html">Client</a> object to use for uploading</p>
</div></div></li><li><h5>force: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>If true, will force upload even if file has already been uploaded</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="File.html" class="tsd-signature-type" data-tsd-kind="Class">File</a><span class="tsd-signature-symbol">></span></h4><div><p>Promise that resolves to the uploaded File object when it completes uploading</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="uploadData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">upload<wbr/>Data<a href="#uploadData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">upload<wbr/>Data<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a>, force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="File.html">File</a>.<a href="File.html#uploadData">uploadData</a></p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L278">File.ts:278</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>See examples at top of file</p>
</div><div><p>Helper function to upload the data to the server</p>
<p>By default, this will skip reuploading data that has already been uploaded.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p><a href="Client.html">Client</a> object to use for uploading</p>
</div></div></li><li><h5>force: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>If true, will force upload even if file has already been uploaded</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="createOpts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> create<wbr/>Opts<a href="#createOpts" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">create<wbr/>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from <a href="File.html">File</a>.<a href="File.html#createOpts">createOpts</a></p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L158">File.ts:158</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="fileFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> file<wbr/>Format<a href="#fileFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">file<wbr/>Format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="File.html">File</a>.<a href="File.html#fileFormat">fileFormat</a></p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L160">File.ts:160</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> name<a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="File.html">File</a>.<a href="File.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L161">File.ts:161</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> type<a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/FileType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">FileType</a></div><aside class="tsd-sources"><p>Inherited from <a href="File.html">File</a>.<a href="File.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L162">File.ts:162</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="uploadUrlOpts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> upload<wbr/>Url<wbr/>Opts<a href="#uploadUrlOpts" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">upload<wbr/>Url<wbr/>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="File.html">File</a>.<a href="File.html#uploadUrlOpts">uploadUrlOpts</a></p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L159">File.ts:159</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link">data<a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> data<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from File.data</p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L134">File.ts:134</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a id="fileCreateResponse" class="tsd-anchor"></a><h3 class="tsd-anchor-link">file<wbr/>Create<wbr/>Response<a href="#fileCreateResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> fileCreateResponse<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from File.fileCreateResponse</p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L145">File.ts:145</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a id="fileCreated" class="tsd-anchor"></a><h3 class="tsd-anchor-link">file<wbr/>Created<a href="#fileCreated" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> fileCreated<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from File.fileCreated</p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L142">File.ts:142</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a id="fileID" class="tsd-anchor"></a><h3 class="tsd-anchor-link">fileID<a href="#fileID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> fileID<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from File.fileID</p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L139">File.ts:139</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a id="fileUploadResponse" class="tsd-anchor"></a><h3 class="tsd-anchor-link">file<wbr/>Upload<wbr/>Response<a href="#fileUploadResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> fileUploadResponse<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from File.fileUploadResponse</p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L154">File.ts:154</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a id="fileUploaded" class="tsd-anchor"></a><h3 class="tsd-anchor-link">file<wbr/>Uploaded<a href="#fileUploaded" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> fileUploaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from File.fileUploaded</p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L148">File.ts:148</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a id="fileValidated" class="tsd-anchor"></a><h3 class="tsd-anchor-link">file<wbr/>Validated<a href="#fileValidated" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> fileValidated<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from File.fileValidated</p><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L151">File.ts:151</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="NodeFile.html" class="tsd-kind-icon">Node<wbr/>File</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="NodeFile.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#createFile" class="tsd-kind-icon">create<wbr/>File</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#createOpts" class="tsd-kind-icon">create<wbr/>Opts</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileCreateResponse" class="tsd-kind-icon">file<wbr/>Create<wbr/>Response</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileCreated" class="tsd-kind-icon">file<wbr/>Created</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileFormat" class="tsd-kind-icon">file<wbr/>Format</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileID" class="tsd-kind-icon">fileID</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileUploadResponse" class="tsd-kind-icon">file<wbr/>Upload<wbr/>Response</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileUploaded" class="tsd-kind-icon">file<wbr/>Uploaded</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#fileValidated" class="tsd-kind-icon">file<wbr/>Validated</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#setData" class="tsd-kind-icon">set<wbr/>Data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#upload" class="tsd-kind-icon">upload</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#uploadData" class="tsd-kind-icon">upload<wbr/>Data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NodeFile.html#uploadUrlOpts" class="tsd-kind-icon">upload<wbr/>Url<wbr/>Opts</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><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></ul><ul class="tsd-legend"><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></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></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>