npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sqlocal-bundle

v1.10.5

Published

SQLocal makes it easy to run SQLite3 in the browser, backed by the origin private file system.

Downloads

33

Readme

SQLocal

SQLocal makes it easy to run SQLite3 in the browser, backed by the origin private file system. It wraps the WebAssembly build of SQLite3 and gives you a simple interface to interact with databases running on device.

based on DallasHoff/sqlocal

Documentation - GitHub - NPM - Fund

What this is

I'm using Next.js with turbo, which does not yet support new Worker(). But I wanted to stay with turbo and use OPFS. So I bundled what's necessary to just include a script tag, wait for the load event and assign the database instance to a local variable that I can use with React.

How to

First install the package

npm install sqlocal-bundle

Then add a postinstall script to your package.json that copies the contents from the sqlocal-bundle package into you public folder like the following (you can also find another way):

import * as path from 'node:path';
import { fileURLToPath } from 'node:url';

import cpy from 'cpy';

const sqlocal = import.meta.resolve('sqlocal-bundle');

if (!sqlocal) {
	throw new Error('Could not resolve sqlocal-bundle');
}

const sqlocalPath = fileURLToPath(sqlocal);

const root = path.resolve(sqlocalPath, '../..', 'bundle');

await cpy(`${root}/*`, 'public/scripts/sqlocal-bundle', { flat: true });
await cpy(`${root}/sqlite-wasm`, 'public/scripts/sqlocal-bundle/sqlite-wasm', { flat: true });

Add another script in public/scripts/sqlocal.mjs that will load the sqlocal-bundle and expose a global variable:

import { SQLocalDrizzle } from './sqlocal-bundle/drizzle.mjs';

globalThis.SQLocalDrizzle = SQLocalDrizzle;

Then add a script tag to your page / layout that loads the script

import Script from 'next/script';

export default function Page() {
  const handleLoad = () => {
    // in case you use react strict mode, you should check if this was already called once ...
    const SQLocal: typeof SQLocalDrizzle = globalThis.SQLocalDrizzle;
    const { driver, sql } = new SQLocal('myopfsdatabase.sqlite3');
    
    /* use sql or driver with drizzle and continue with your code */
  }

  return (
    <>
      <Script onLoad={() => void handleLoad()} src="/static/scripts/sqlocal.mjs" type="module" />
      {/* Your page content */}
    </>
  )
}

Make sure to follow the docs for SQLocal and also don't forget that OPFS requires certain headers that can be set in your next.config.js file:

headers: async () => {
  return [
    {
      /* required for https://github.com/sqlite/sqlite-wasm */
      headers: [
        { key: 'Cross-Origin-Opener-Policy', value: 'same-origin' },
        { key: 'Cross-Origin-Embedder-Policy', value: 'require-corp' },
      ],
    },
  ];
},