Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 886 Bytes

getJSONProgress.md

File metadata and controls

29 lines (20 loc) · 886 Bytes
Raw

getJSONProgress(object)

Return the number of bytes loaded when the JSON snapshot was created as well as the total file size (if available)

Syntax

function Widget(url) {
  const [ list, more ] = usePartialJSON(url);
  const { done } = getJSONProgress(list);
  const perPage = 10;
  // the number of pages is known only if the file is fully loaded
  const pageCount = (done) ? list.length / perPage : Infinity;
}

Parameters

  • object - <object> or <array> A JSON object returned by one of the library's functions
  • return { loaded, total, done, brackets }

Notes

brackets is a string containing the end brackets used to complete a partially retrieved JSON object. It's empty for the final, complete object.

total is undefined when HTTP chunk encoding is used.

getJSONProgress returns an empty object when given an unknown object or a scalar.