mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
update website
This commit is contained in:
Christopher Chedeau
+5
-228
@@ -2,237 +2,14 @@
|
||||
system. It should be used instead of LocalStorage.</p><p>It is recommended that you use an abstraction on top of AsyncStorage instead
|
||||
of AsyncStorage directly for anything more than light usage since it
|
||||
operates globally.</p><p>This JS code is a simple facad over the native iOS implementation to provide
|
||||
a clear JS API, real Error objects, and simple non-multi functions.</p></div><div class="props"><div class="prop"><h4 class="propTitle"><a class="anchor" name="getitem"></a><span class="propType">static </span>getItem(<span class="propType">key: string, callback: (error: ?Error, result: ?string) => void</span>) <a class="hash-link" href="#getitem">#</a></h4><div><p>Fetches <code>key</code> and passes the result to <code>callback</code>, along with an <code>Error</code> if
|
||||
a clear JS API, real Error objects, and simple non-multi functions.</p></div><h3><a class="anchor" name="methods"></a>Methods <a class="hash-link" href="#methods">#</a></h3><div class="props"><div class="prop"><h4 class="propTitle"><a class="anchor" name="getitem"></a><span class="propType">static </span>getItem(<span class="propType">key: string, callback: (error: ?Error, result: ?string) => void</span>) <a class="hash-link" href="#getitem">#</a></h4><div><p>Fetches <code>key</code> and passes the result to <code>callback</code>, along with an <code>Error</code> if
|
||||
there is any.</p></div></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="setitem"></a><span class="propType">static </span>setItem(<span class="propType">key: string, value: string, callback: ?(error: ?Error) => void</span>) <a class="hash-link" href="#setitem">#</a></h4><div><p>Sets <code>value</code> for <code>key</code> and calls <code>callback</code> on completion, along with an
|
||||
<code>Error</code> if there is any.</p></div></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="removeitem"></a><span class="propType">static </span>removeItem(<span class="propType">key: string, callback: ?(error: ?Error) => void</span>) <a class="hash-link" href="#removeitem">#</a></h4></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="mergeitem"></a><span class="propType">static </span>mergeItem(<span class="propType">key: string, value: string, callback: ?(error: ?Error) => void</span>) <a class="hash-link" href="#mergeitem">#</a></h4><div><p>Merges existing value with input value, assuming they are stringified json.</p><p>Not supported by all native implementations.</p></div></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="clear"></a><span class="propType">static </span>clear(<span class="propType">callback: ?(error: ?Error) => void</span>) <a class="hash-link" href="#clear">#</a></h4><div><p>Erases <em>all</em> AsyncStorage for all clients, libraries, etc. You probably
|
||||
don't want to call this - use removeItem or multiRemove to clear only your
|
||||
own keys instead.</p></div></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="getallkeys"></a><span class="propType">static </span>getAllKeys(<span class="propType">callback: (error: ?Error) => void</span>) <a class="hash-link" href="#getallkeys">#</a></h4><div><p>Gets <em>all</em> keys known to the system, for all callers, libraries, etc.</p></div></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="multiget"></a><span class="propType">static </span>multiGet(<span class="propType">keys: :({"type":"generic","value":[{"type":"simple","value":"Array","length":1},{"type":"simple","value":"string","length":1}],"length":4}, callback: (errors: ?Array<Error>, result: ?Array<Array<string>>) => void</span>) <a class="hash-link" href="#multiget">#</a></h4><div><p>multiGet invokes callback with an array of key-value pair arrays that
|
||||
matches the input format of multiSet.</p><p>multiGet(['k1', 'k2'], cb) -> cb([['k1', 'val1'], ['k2', 'val2']])</p></div></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="multiset"></a><span class="propType">static </span>multiSet(<span class="propType">keyValuePairs: :({"type":"generic","value":[{"type":"simple","value":"Array","length":1},{"type":"generic","value":[{"type":"simple","value":"Array","length":1},{"type":"simple","value":"string","length":1}],"length":4}],"length":7}, callback: ?(errors: ?Array<Error>) => void</span>) <a class="hash-link" href="#multiset">#</a></h4><div><p>multiSet and multiMerge take arrays of key-value array pairs that match
|
||||
the output of multiGet, e.g.</p><p>multiSet([['k1', 'val1'], ['k2', 'val2']], cb);</p></div></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="multiremove"></a><span class="propType">static </span>multiRemove(<span class="propType">keys: :({"type":"generic","value":[{"type":"simple","value":"Array","length":1},{"type":"simple","value":"string","length":1}],"length":4}, callback: ?(errors: ?Array<Error>) => void</span>) <a class="hash-link" href="#multiremove">#</a></h4><div><p>Delete all the keys in the <code>keys</code> array.</p></div></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="multimerge"></a><span class="propType">static </span>multiMerge(<span class="propType">keyValuePairs: :({"type":"generic","value":[{"type":"simple","value":"Array","length":1},{"type":"generic","value":[{"type":"simple","value":"Array","length":1},{"type":"simple","value":"string","length":1}],"length":4}],"length":7}, callback: ?(errors: ?Array<Error>) => void</span>) <a class="hash-link" href="#multimerge">#</a></h4><div><p>Merges existing values with input values, assuming they are stringified
|
||||
json.</p><p>Not supported by all native implementations.</p></div></div></div><pre>{
|
||||
"methods": [
|
||||
{
|
||||
"line": 32,
|
||||
"source": "getItem: function(\n key: string,\n callback: (error: ?Error, result: ?string) => void\n ): void {\n RKAsyncStorage.multiGet([key], function(errors, result) {\n // Unpack result to get value from [[key,value]]\n var value = (result && result[0] && result[0][1]) ? result[0][1] : null;\n callback((errors && convertError(errors[0])) || null, value);\n });\n }",
|
||||
"docblock": "/**\n * Fetches `key` and passes the result to `callback`, along with an `Error` if\n * there is any.\n */\n",
|
||||
"modifiers": [
|
||||
"static"
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"typehint": "{\"type\":\"simple\",\"value\":\"string\",\"length\":1}",
|
||||
"name": "key"
|
||||
},
|
||||
{
|
||||
"typehint": "(error: ?Error, result: ?string) => void",
|
||||
"name": "callback"
|
||||
}
|
||||
],
|
||||
"tparams": null,
|
||||
"returntypehint": "void",
|
||||
"name": "getItem"
|
||||
},
|
||||
{
|
||||
"line": 47,
|
||||
"source": "setItem: function(\n key: string,\n value: string,\n callback: ?(error: ?Error) => void\n ): void {\n RKAsyncStorage.multiSet([[key,value]], function(errors) {\n callback && callback((errors && convertError(errors[0])) || null);\n });\n }",
|
||||
"docblock": "/**\n * Sets `value` for `key` and calls `callback` on completion, along with an\n * `Error` if there is any.\n */\n",
|
||||
"modifiers": [
|
||||
"static"
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"typehint": "{\"type\":\"simple\",\"value\":\"string\",\"length\":1}",
|
||||
"name": "key"
|
||||
},
|
||||
{
|
||||
"typehint": "{\"type\":\"simple\",\"value\":\"string\",\"length\":1}",
|
||||
"name": "value"
|
||||
},
|
||||
{
|
||||
"typehint": "?(error: ?Error) => void",
|
||||
"name": "callback"
|
||||
}
|
||||
],
|
||||
"tparams": null,
|
||||
"returntypehint": "void",
|
||||
"name": "setItem"
|
||||
},
|
||||
{
|
||||
"line": 57,
|
||||
"source": "removeItem: function(\n key: string,\n callback: ?(error: ?Error) => void\n ): void {\n RKAsyncStorage.multiRemove([key], function(errors) {\n callback && callback((errors && convertError(errors[0])) || null);\n });\n }",
|
||||
"modifiers": [
|
||||
"static"
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"typehint": "{\"type\":\"simple\",\"value\":\"string\",\"length\":1}",
|
||||
"name": "key"
|
||||
},
|
||||
{
|
||||
"typehint": "?(error: ?Error) => void",
|
||||
"name": "callback"
|
||||
}
|
||||
],
|
||||
"tparams": null,
|
||||
"returntypehint": "void",
|
||||
"name": "removeItem"
|
||||
},
|
||||
{
|
||||
"line": 71,
|
||||
"source": "mergeItem: function(\n key: string,\n value: string,\n callback: ?(error: ?Error) => void\n ): void {\n RKAsyncStorage.multiMerge([[key,value]], function(errors) {\n callback && callback((errors && convertError(errors[0])) || null);\n });\n }",
|
||||
"docblock": "/**\n * Merges existing value with input value, assuming they are stringified json.\n *\n * Not supported by all native implementations.\n */\n",
|
||||
"modifiers": [
|
||||
"static"
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"typehint": "{\"type\":\"simple\",\"value\":\"string\",\"length\":1}",
|
||||
"name": "key"
|
||||
},
|
||||
{
|
||||
"typehint": "{\"type\":\"simple\",\"value\":\"string\",\"length\":1}",
|
||||
"name": "value"
|
||||
},
|
||||
{
|
||||
"typehint": "?(error: ?Error) => void",
|
||||
"name": "callback"
|
||||
}
|
||||
],
|
||||
"tparams": null,
|
||||
"returntypehint": "void",
|
||||
"name": "mergeItem"
|
||||
},
|
||||
{
|
||||
"line": 86,
|
||||
"source": "clear: function(callback: ?(error: ?Error) => void) {\n RKAsyncStorage.clear(function(error) {\n callback && callback(convertError(error));\n });\n }",
|
||||
"docblock": "/**\n * Erases *all* AsyncStorage for all clients, libraries, etc. You probably\n * don't want to call this - use removeItem or multiRemove to clear only your\n * own keys instead.\n */\n",
|
||||
"modifiers": [
|
||||
"static"
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"typehint": "?(error: ?Error) => void",
|
||||
"name": "callback"
|
||||
}
|
||||
],
|
||||
"tparams": null,
|
||||
"returntypehint": null,
|
||||
"name": "clear"
|
||||
},
|
||||
{
|
||||
"line": 95,
|
||||
"source": "getAllKeys: function(callback: (error: ?Error) => void) {\n RKAsyncStorage.getAllKeys(function(error, keys) {\n callback(convertError(error), keys);\n });\n }",
|
||||
"docblock": "/**\n * Gets *all* keys known to the system, for all callers, libraries, etc.\n */\n",
|
||||
"modifiers": [
|
||||
"static"
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"typehint": "(error: ?Error) => void",
|
||||
"name": "callback"
|
||||
}
|
||||
],
|
||||
"tparams": null,
|
||||
"returntypehint": null,
|
||||
"name": "getAllKeys"
|
||||
},
|
||||
{
|
||||
"line": 117,
|
||||
"source": "multiGet: function(\n keys: Array<string>,\n callback: (errors: ?Array<Error>, result: ?Array<Array<string>>) => void\n ): void {\n RKAsyncStorage.multiGet(keys, function(errors, result) {\n callback(\n (errors && errors.map((error) => convertError(error))) || null,\n result\n );\n });\n }",
|
||||
"docblock": "/**\n * multiGet invokes callback with an array of key-value pair arrays that\n * matches the input format of multiSet.\n *\n * multiGet(['k1', 'k2'], cb) -> cb([['k1', 'val1'], ['k2', 'val2']])\n */\n",
|
||||
"modifiers": [
|
||||
"static"
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"typehint": "{\"type\":\"generic\",\"value\":[{\"type\":\"simple\",\"value\":\"Array\",\"length\":1},{\"type\":\"simple\",\"value\":\"string\",\"length\":1}],\"length\":4}",
|
||||
"name": "keys"
|
||||
},
|
||||
{
|
||||
"typehint": "(errors: ?Array<Error>, result: ?Array<Array<string>>) => void",
|
||||
"name": "callback"
|
||||
}
|
||||
],
|
||||
"tparams": null,
|
||||
"returntypehint": "void",
|
||||
"name": "multiGet"
|
||||
},
|
||||
{
|
||||
"line": 135,
|
||||
"source": "multiSet: function(\n keyValuePairs: Array<Array<string>>,\n callback: ?(errors: ?Array<Error>) => void\n ): void {\n RKAsyncStorage.multiSet(keyValuePairs, function(errors) {\n callback && callback(\n (errors && errors.map((error) => convertError(error))) || null\n );\n });\n }",
|
||||
"docblock": "/**\n * multiSet and multiMerge take arrays of key-value array pairs that match\n * the output of multiGet, e.g.\n *\n * multiSet([['k1', 'val1'], ['k2', 'val2']], cb);\n */\n",
|
||||
"modifiers": [
|
||||
"static"
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"typehint": "{\"type\":\"generic\",\"value\":[{\"type\":\"simple\",\"value\":\"Array\",\"length\":1},{\"type\":\"generic\",\"value\":[{\"type\":\"simple\",\"value\":\"Array\",\"length\":1},{\"type\":\"simple\",\"value\":\"string\",\"length\":1}],\"length\":4}],\"length\":7}",
|
||||
"name": "keyValuePairs"
|
||||
},
|
||||
{
|
||||
"typehint": "?(errors: ?Array<Error>) => void",
|
||||
"name": "callback"
|
||||
}
|
||||
],
|
||||
"tparams": null,
|
||||
"returntypehint": "void",
|
||||
"name": "multiSet"
|
||||
},
|
||||
{
|
||||
"line": 149,
|
||||
"source": "multiRemove: function(\n keys: Array<string>,\n callback: ?(errors: ?Array<Error>) => void\n ): void {\n RKAsyncStorage.multiRemove(keys, function(errors) {\n callback && callback(\n (errors && errors.map((error) => convertError(error))) || null\n );\n });\n }",
|
||||
"docblock": "/**\n * Delete all the keys in the `keys` array.\n */\n",
|
||||
"modifiers": [
|
||||
"static"
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"typehint": "{\"type\":\"generic\",\"value\":[{\"type\":\"simple\",\"value\":\"Array\",\"length\":1},{\"type\":\"simple\",\"value\":\"string\",\"length\":1}],\"length\":4}",
|
||||
"name": "keys"
|
||||
},
|
||||
{
|
||||
"typehint": "?(errors: ?Array<Error>) => void",
|
||||
"name": "callback"
|
||||
}
|
||||
],
|
||||
"tparams": null,
|
||||
"returntypehint": "void",
|
||||
"name": "multiRemove"
|
||||
},
|
||||
{
|
||||
"line": 166,
|
||||
"source": "multiMerge: function(\n keyValuePairs: Array<Array<string>>,\n callback: ?(errors: ?Array<Error>) => void\n ): void {\n RKAsyncStorage.multiMerge(keyValuePairs, function(errors) {\n callback && callback(\n (errors && errors.map((error) => convertError(error))) || null\n );\n });\n }",
|
||||
"docblock": "/**\n * Merges existing values with input values, assuming they are stringified\n * json.\n *\n * Not supported by all native implementations.\n */\n",
|
||||
"modifiers": [
|
||||
"static"
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"typehint": "{\"type\":\"generic\",\"value\":[{\"type\":\"simple\",\"value\":\"Array\",\"length\":1},{\"type\":\"generic\",\"value\":[{\"type\":\"simple\",\"value\":\"Array\",\"length\":1},{\"type\":\"simple\",\"value\":\"string\",\"length\":1}],\"length\":4}],\"length\":7}",
|
||||
"name": "keyValuePairs"
|
||||
},
|
||||
{
|
||||
"typehint": "?(errors: ?Array<Error>) => void",
|
||||
"name": "callback"
|
||||
}
|
||||
],
|
||||
"tparams": null,
|
||||
"returntypehint": "void",
|
||||
"name": "multiMerge"
|
||||
}
|
||||
],
|
||||
"properties": [],
|
||||
"superClass": null,
|
||||
"type": "api",
|
||||
"line": 27,
|
||||
"name": "AsyncStorage",
|
||||
"docblock": "/**\n * AsyncStorage is a simple, asynchronous, persistent, global, key-value storage\n * system. It should be used instead of LocalStorage.\n *\n * It is recommended that you use an abstraction on top of AsyncStorage instead\n * of AsyncStorage directly for anything more than light usage since it\n * operates globally.\n *\n * This JS code is a simple facad over the native iOS implementation to provide\n * a clear JS API, real Error objects, and simple non-multi functions.\n */\n",
|
||||
"requires": [
|
||||
{
|
||||
"name": "NativeModulesDeprecated"
|
||||
}
|
||||
]
|
||||
}</pre></div><noscript></noscript><div class="docs-prevnext"><a class="docs-next" href="cameraroll.html#content">Next →</a></div></div></section><footer class="wrap"><div class="right">© 2015 Facebook Inc.</div></footer></div><div id="fb-root"></div><script>
|
||||
own keys instead.</p></div></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="getallkeys"></a><span class="propType">static </span>getAllKeys(<span class="propType">callback: (error: ?Error) => void</span>) <a class="hash-link" href="#getallkeys">#</a></h4><div><p>Gets <em>all</em> keys known to the system, for all callers, libraries, etc.</p></div></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="multiget"></a><span class="propType">static </span>multiGet(<span class="propType">keys: Array<string>, callback: (errors: ?Array<Error>, result: ?Array<Array<string>>) => void</span>) <a class="hash-link" href="#multiget">#</a></h4><div><p>multiGet invokes callback with an array of key-value pair arrays that
|
||||
matches the input format of multiSet.</p><p>multiGet(['k1', 'k2'], cb) -> cb([['k1', 'val1'], ['k2', 'val2']])</p></div></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="multiset"></a><span class="propType">static </span>multiSet(<span class="propType">keyValuePairs: Array<Array<string>>, callback: ?(errors: ?Array<Error>) => void</span>) <a class="hash-link" href="#multiset">#</a></h4><div><p>multiSet and multiMerge take arrays of key-value array pairs that match
|
||||
the output of multiGet, e.g.</p><p>multiSet([['k1', 'val1'], ['k2', 'val2']], cb);</p></div></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="multiremove"></a><span class="propType">static </span>multiRemove(<span class="propType">keys: Array<string>, callback: ?(errors: ?Array<Error>) => void</span>) <a class="hash-link" href="#multiremove">#</a></h4><div><p>Delete all the keys in the <code>keys</code> array.</p></div></div><div class="prop"><h4 class="propTitle"><a class="anchor" name="multimerge"></a><span class="propType">static </span>multiMerge(<span class="propType">keyValuePairs: Array<Array<string>>, callback: ?(errors: ?Array<Error>) => void</span>) <a class="hash-link" href="#multimerge">#</a></h4><div><p>Merges existing values with input values, assuming they are stringified
|
||||
json.</p><p>Not supported by all native implementations.</p></div></div></div></div><noscript></noscript><div class="docs-prevnext"><a class="docs-next" href="cameraroll.html#content">Next →</a></div></div></section><footer class="wrap"><div class="right">© 2015 Facebook Inc.</div></footer></div><div id="fb-root"></div><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
|
||||
Reference in New Issue
Block a user