xref: /expo/docs/public/static/data/unversioned/expo-sqlite.json (revision dfd15ebd)

{"name":"expo-sqlite","kind":1,"kindString":"Project","originalName":"","children":[{"name":"SQLError","kind":128,"kindString":"Class","children":[{"name":"constructor","kind":512,"kindString":"Constructor","signatures":[{"name":"new SQLError","kind":16384,"kindString":"Constructor signature","type":{"type":"reference","name":"SQLError"}}]},{"name":"code","kind":1024,"kindString":"Property","type":{"type":"intrinsic","name":"number"}},{"name":"message","kind":1024,"kindString":"Property","type":{"type":"intrinsic","name":"string"}},{"name":"CONSTRAINT_ERR","kind":1024,"kindString":"Property","flags":{"isStatic":true},"type":{"type":"intrinsic","name":"number"}},{"name":"DATABASE_ERR","kind":1024,"kindString":"Property","flags":{"isStatic":true},"type":{"type":"intrinsic","name":"number"}},{"name":"QUOTA_ERR","kind":1024,"kindString":"Property","flags":{"isStatic":true},"type":{"type":"intrinsic","name":"number"}},{"name":"SYNTAX_ERR","kind":1024,"kindString":"Property","flags":{"isStatic":true},"type":{"type":"intrinsic","name":"number"}},{"name":"TIMEOUT_ERR","kind":1024,"kindString":"Property","flags":{"isStatic":true},"type":{"type":"intrinsic","name":"number"}},{"name":"TOO_LARGE_ERR","kind":1024,"kindString":"Property","flags":{"isStatic":true},"type":{"type":"intrinsic","name":"number"}},{"name":"UNKNOWN_ERR","kind":1024,"kindString":"Property","flags":{"isStatic":true},"type":{"type":"intrinsic","name":"number"}},{"name":"VERSION_ERR","kind":1024,"kindString":"Property","flags":{"isStatic":true},"type":{"type":"intrinsic","name":"number"}}]},{"name":"Database","kind":256,"kindString":"Interface","comment":{"shortText":"`Database` objects are returned by calls to `SQLite.openDatabase()`. Such an object represents a\nconnection to a database on your device."},"children":[{"name":"version","kind":1024,"kindString":"Property","type":{"type":"intrinsic","name":"string"}},{"name":"readTransaction","kind":2048,"kindString":"Method","signatures":[{"name":"readTransaction","kind":4096,"kindString":"Call signature","parameters":[{"name":"callback","kind":32768,"kindString":"Parameter","type":{"type":"reference","name":"SQLTransactionCallback"}},{"name":"errorCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"SQLTransactionErrorCallback"}},{"name":"successCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","signatures":[{"name":"__type","kind":4096,"kindString":"Call signature","type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"intrinsic","name":"void"}}]},{"name":"transaction","kind":2048,"kindString":"Method","signatures":[{"name":"transaction","kind":4096,"kindString":"Call signature","comment":{"shortText":"Execute a database transaction."},"parameters":[{"name":"callback","kind":32768,"kindString":"Parameter","comment":{"shortText":"A function representing the transaction to perform. Takes a Transaction\n(see below) as its only parameter, on which it can add SQL statements to execute."},"type":{"type":"reference","name":"SQLTransactionCallback"}},{"name":"errorCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"Called if an error occurred processing this transaction. Takes a single\nparameter describing the error."},"type":{"type":"reference","name":"SQLTransactionErrorCallback"}},{"name":"successCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"Called when the transaction has completed executing on the database.\n"},"type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","signatures":[{"name":"__type","kind":4096,"kindString":"Call signature","type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"intrinsic","name":"void"}}]}],"extendedBy":[{"type":"reference","name":"WebSQLDatabase"}]},{"name":"SQLResultSetRowList","kind":256,"kindString":"Interface","children":[{"name":"_array","kind":1024,"kindString":"Property","comment":{"shortText":"The actual array of rows returned by the query. Can be used directly instead of\ngetting rows through rows.item()."},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}},{"name":"length","kind":1024,"kindString":"Property","comment":{"shortText":"The number of rows returned by the query."},"type":{"type":"intrinsic","name":"number"}},{"name":"item","kind":2048,"kindString":"Method","signatures":[{"name":"item","kind":4096,"kindString":"Call signature","comment":{"shortText":"Returns the row with the given `index`. If there is no such row, returns `null`."},"parameters":[{"name":"index","kind":32768,"kindString":"Parameter","comment":{"shortText":"Index of row to get.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"any"}}]}]},{"name":"SQLTransaction","kind":256,"kindString":"Interface","comment":{"shortText":"A `SQLTransaction` object is passed in as a parameter to the `callback` parameter for the\n`db.transaction()` method on a `Database` (see above). It allows enqueuing SQL statements to\nperform in a database transaction."},"children":[{"name":"executeSql","kind":2048,"kindString":"Method","signatures":[{"name":"executeSql","kind":4096,"kindString":"Call signature","comment":{"shortText":"Enqueue a SQL statement to execute in the transaction. Authors are strongly recommended to make\nuse of the `?` placeholder feature of the method to avoid against SQL injection attacks, and to\nnever construct SQL statements on the fly."},"parameters":[{"name":"sqlStatement","kind":32768,"kindString":"Parameter","comment":{"shortText":"A string containing a database query to execute expressed as SQL. The string\nmay contain `?` placeholders, with values to be substituted listed in the `arguments` parameter."},"type":{"type":"intrinsic","name":"string"}},{"name":"args","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"An array of values (numbers, strings or nulls) to substitute for `?` placeholders in the\nSQL statement."},"type":{"type":"array","elementType":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"}]}}},{"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"Called when the query is successfully completed during the transaction. Takes\ntwo parameters: the transaction itself, and a `ResultSet` object (see below) with the results\nof the query."},"type":{"type":"reference","name":"SQLStatementCallback"}},{"name":"errorCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"Called if an error occurred executing this particular query in the\ntransaction. Takes two parameters: the transaction itself, and the error object.\n"},"type":{"type":"reference","name":"SQLStatementErrorCallback"}}],"type":{"type":"intrinsic","name":"void"}}]}]},{"name":"WebSQLDatabase","kind":256,"kindString":"Interface","children":[{"name":"version","kind":1024,"kindString":"Property","type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"Database.version"}},{"name":"closeAsync","kind":2048,"kindString":"Method","signatures":[{"name":"closeAsync","kind":4096,"kindString":"Call signature","comment":{"shortText":"Close the database."},"type":{"type":"intrinsic","name":"void"}}]},{"name":"deleteAsync","kind":2048,"kindString":"Method","signatures":[{"name":"deleteAsync","kind":4096,"kindString":"Call signature","comment":{"shortText":"Delete the database file.\n> The database has to be closed prior to deletion."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"name":"exec","kind":2048,"kindString":"Method","signatures":[{"name":"exec","kind":4096,"kindString":"Call signature","parameters":[{"name":"queries","kind":32768,"kindString":"Parameter","type":{"type":"array","elementType":{"type":"reference","name":"Query"}}},{"name":"readOnly","kind":32768,"kindString":"Parameter","type":{"type":"intrinsic","name":"boolean"}},{"name":"callback","kind":32768,"kindString":"Parameter","type":{"type":"reference","name":"SQLiteCallback"}}],"type":{"type":"intrinsic","name":"void"}}]},{"name":"readTransaction","kind":2048,"kindString":"Method","signatures":[{"name":"readTransaction","kind":4096,"kindString":"Call signature","parameters":[{"name":"callback","kind":32768,"kindString":"Parameter","type":{"type":"reference","name":"SQLTransactionCallback"}},{"name":"errorCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"SQLTransactionErrorCallback"}},{"name":"successCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","signatures":[{"name":"__type","kind":4096,"kindString":"Call signature","type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","name":"Database.readTransaction"}}],"inheritedFrom":{"type":"reference","name":"Database.readTransaction"}},{"name":"transaction","kind":2048,"kindString":"Method","signatures":[{"name":"transaction","kind":4096,"kindString":"Call signature","comment":{"shortText":"Execute a database transaction."},"parameters":[{"name":"callback","kind":32768,"kindString":"Parameter","comment":{"shortText":"A function representing the transaction to perform. Takes a Transaction\n(see below) as its only parameter, on which it can add SQL statements to execute."},"type":{"type":"reference","name":"SQLTransactionCallback"}},{"name":"errorCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"Called if an error occurred processing this transaction. Takes a single\nparameter describing the error."},"type":{"type":"reference","name":"SQLTransactionErrorCallback"}},{"name":"successCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"Called when the transaction has completed executing on the database.\n"},"type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","signatures":[{"name":"__type","kind":4096,"kindString":"Call signature","type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","name":"Database.transaction"}}],"inheritedFrom":{"type":"reference","name":"Database.transaction"}}],"extendedTypes":[{"type":"reference","name":"Database"}]},{"name":"Window","kind":256,"kindString":"Interface","children":[{"name":"openDatabase","kind":2048,"kindString":"Method","flags":{"isOptional":true},"signatures":[{"name":"openDatabase","kind":4096,"kindString":"Call signature","parameters":[{"name":"name","kind":32768,"kindString":"Parameter","type":{"type":"intrinsic","name":"string"}},{"name":"version","kind":32768,"kindString":"Parameter","type":{"type":"intrinsic","name":"string"}},{"name":"displayName","kind":32768,"kindString":"Parameter","type":{"type":"intrinsic","name":"string"}},{"name":"estimatedSize","kind":32768,"kindString":"Parameter","type":{"type":"intrinsic","name":"number"}},{"name":"creationCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"DatabaseCallback"}}],"type":{"type":"reference","name":"Database"}}]}]},{"name":"DatabaseCallback","kind":4194304,"kindString":"Type alias","type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","signatures":[{"name":"__type","kind":4096,"kindString":"Call signature","parameters":[{"name":"database","kind":32768,"kindString":"Parameter","type":{"type":"reference","name":"Database"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"name":"Query","kind":4194304,"kindString":"Type alias","type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","children":[{"name":"args","kind":1024,"kindString":"Property","type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"name":"sql","kind":1024,"kindString":"Property","type":{"type":"intrinsic","name":"string"}}]}}},{"name":"ResultSet","kind":4194304,"kindString":"Type alias","comment":{"shortText":"`ResultSet` objects are returned through second parameter of the `success` callback for the\n`tx.executeSql()` method on a `SQLTransaction` (see above)."},"type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","children":[{"name":"insertId","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The row ID of the row that the SQL statement inserted into the database, if a row was inserted."},"type":{"type":"intrinsic","name":"number"}},{"name":"rows","kind":1024,"kindString":"Property","type":{"type":"array","elementType":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","indexSignature":{"name":"__index","kind":8192,"kindString":"Index signature","parameters":[{"name":"column","kind":32768,"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}}}}},{"name":"rowsAffected","kind":1024,"kindString":"Property","comment":{"shortText":"The number of rows that were changed by the SQL statement."},"type":{"type":"intrinsic","name":"number"}}]}}},{"name":"ResultSetError","kind":4194304,"kindString":"Type alias","type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","children":[{"name":"error","kind":1024,"kindString":"Property","type":{"type":"reference","qualifiedName":"Error","package":"typescript","name":"Error"}}]}}},{"name":"SQLResultSet","kind":4194304,"kindString":"Type alias","type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","children":[{"name":"insertId","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The row ID of the row that the SQL statement inserted into the database, if a row was inserted."},"type":{"type":"intrinsic","name":"number"}},{"name":"rows","kind":1024,"kindString":"Property","type":{"type":"reference","name":"SQLResultSetRowList"}},{"name":"rowsAffected","kind":1024,"kindString":"Property","comment":{"shortText":"The number of rows that were changed by the SQL statement."},"type":{"type":"intrinsic","name":"number"}}]}}},{"name":"SQLStatementCallback","kind":4194304,"kindString":"Type alias","type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","signatures":[{"name":"__type","kind":4096,"kindString":"Call signature","parameters":[{"name":"transaction","kind":32768,"kindString":"Parameter","type":{"type":"reference","name":"SQLTransaction"}},{"name":"resultSet","kind":32768,"kindString":"Parameter","type":{"type":"reference","name":"SQLResultSet"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"name":"SQLStatementErrorCallback","kind":4194304,"kindString":"Type alias","type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","signatures":[{"name":"__type","kind":4096,"kindString":"Call signature","parameters":[{"name":"transaction","kind":32768,"kindString":"Parameter","type":{"type":"reference","name":"SQLTransaction"}},{"name":"error","kind":32768,"kindString":"Parameter","type":{"type":"reference","name":"SQLError"}}],"type":{"type":"intrinsic","name":"boolean"}}]}}},{"name":"SQLTransactionCallback","kind":4194304,"kindString":"Type alias","type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","signatures":[{"name":"__type","kind":4096,"kindString":"Call signature","parameters":[{"name":"transaction","kind":32768,"kindString":"Parameter","type":{"type":"reference","name":"SQLTransaction"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"name":"SQLTransactionErrorCallback","kind":4194304,"kindString":"Type alias","type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","signatures":[{"name":"__type","kind":4096,"kindString":"Call signature","parameters":[{"name":"error","kind":32768,"kindString":"Parameter","type":{"type":"reference","name":"SQLError"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"name":"SQLiteCallback","kind":4194304,"kindString":"Type alias","type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","signatures":[{"name":"__type","kind":4096,"kindString":"Call signature","parameters":[{"name":"error","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","qualifiedName":"Error","package":"typescript","name":"Error"},{"type":"literal","value":null}]}},{"name":"resultSet","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"union","types":[{"type":"reference","name":"ResultSetError"},{"type":"reference","name":"ResultSet"}]}}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"name":"openDatabase","kind":64,"kindString":"Function","signatures":[{"name":"openDatabase","kind":4096,"kindString":"Call signature","comment":{"shortText":"Open a database, creating it if it doesn't exist, and return a `Database` object. On disk,\nthe database will be created under the app's [documents directory](./filesystem), i.e.\n`${FileSystem.documentDirectory}/SQLite/${name}`.\n> The `version`, `description` and `size` arguments are ignored, but are accepted by the function\nfor compatibility with the WebSQL specification.","returns":"\n"},"parameters":[{"name":"name","kind":32768,"kindString":"Parameter","comment":{"shortText":"Name of the database file to open."},"type":{"type":"intrinsic","name":"string"}},{"name":"version","kind":32768,"kindString":"Parameter","comment":{},"type":{"type":"intrinsic","name":"string"},"defaultValue":"'1.0'"},{"name":"description","kind":32768,"kindString":"Parameter","comment":{},"type":{"type":"intrinsic","name":"string"},"defaultValue":"name"},{"name":"size","kind":32768,"kindString":"Parameter","comment":{},"type":{"type":"intrinsic","name":"number"},"defaultValue":"1"},{"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{},"type":{"type":"reflection","declaration":{"name":"__type","kind":65536,"kindString":"Type literal","signatures":[{"name":"__type","kind":4096,"kindString":"Call signature","parameters":[{"name":"db","kind":32768,"kindString":"Parameter","type":{"type":"reference","name":"WebSQLDatabase"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","name":"WebSQLDatabase"}}]}]}