Array of records corresponding to the current frame. Call sync() to push changes that you have made to this array.
This function is how you access a single object your current frame. This function does not get new data or push changes to Easybase. If you want to syncronize your frame and Easybase, call sync() then Frame().
Single record corresponding to that object within the current frame. Call sync() to push changes that you have made to this object.
QueryOptions
Isolated array of records in the same form as Frame(). Editing this array has no effect and cannot be synced with your database. Use Frame() for realtime database features.
Manually add a record to your collection regardless of your current frame. You must call sync() after this to see updated response.
AddRecordOptions
Promise
Configure the current frame size. Set the offset and amount of records to retreive assume you don't want to receive your entire collection. This is useful for paging.
ConfigureFrameOptions
StatusResponse
View your frames current configuration
Object contains the offset and length of your current frame.
Manually delete a record from your collection regardless of your current frame. You must call sync() after this to see updated response.
Promise
Gets the number of records in your table.
The the number of records in your table.
Gets the number of records in your table.
The the number of records in your table.
Retrieve the currently signed in users attribute object.
Promise<Record<string, string>>
Check if a user is currently signed in.
Pass a callback function to run when a user signs in. This callback function will run after either successfully signing in with the signIn() function OR after a user is automatically signed in via valid tokens saved to the browser from a previous instance. This is best placed with useEffect(() => {}, []);
callback function to run on sign in event
Set a single attribute of the currently signed in user. Can also be updated visually in the Easybase 'Users' tab.
Object key. Can be a new key or existing key.
attribute value.
Promise
Sign in a user that already exists for a project. This will save authentication tokens to a user's browser so that they will be automatically authenticated when they return to the application. These authentcation tokens will become invalid when a user signs out or after 24 hours.
unique identifier for new user. Usually an email or phone number.
user password.
Promise
Sign out the current user and invalidate their cached tokens.
Create a new user for your project. You must still call signIn() after signing up.
unique identifier for new user. Usually an email or phone number.
user password. Must be at least 8 characters long.
Optional object to store user attributes. Can also be edited visually in the Easybase 'Users' tab.
Promise
Call this method to syncronize your current changes with your database. Delections, additions, and changes will all be reflected by your backend after calling this method. Call Frame() after this to get a normalized array of the freshest data.
Promise
Retrieve an object detailing the columns in your table mapped to their corresponding type.
Object detailing the columns in your table mapped to their corresponding type.
Retrieve an object detailing the columns in your table mapped to their corresponding type.
Object detailing the columns in your table mapped to their corresponding type.
Upload a file to your backend and attach it to a specific record. columnName must reference a column of type 'file'. Call sync() for fresh data with proper attachment links to cloud hosting.
UpdateRecordAttachmentOptions
Promise
Upload an image to your backend and attach it to a specific record. columnName must reference a column of type 'image'. The file must have an extension of an image. Call sync() for fresh data with proper attachment links to cloud hosting.
UpdateRecordAttachmentOptions
Promise
Upload a video to your backend and attach it to a specific record. columnName must reference a column of type 'video'. The file must have an extension of a video. Call sync() for fresh data with proper attachment links to cloud hosting.
UpdateRecordAttachmentOptions
Promise
This hook runs when the Frame changes. This can be triggered by calling sync().
Callback function that executes when Frame changes.
Generated using TypeDoc
This function is how you access your current frame. This function does not get new data or push changes to Easybase. If you want to syncronize your frame and Easybase, call sync() then Frame().