Skip to main content

Quick Start

Next.js Setup​

Install​

Let's start by installing the required packages.

shell
npm install @edgestore/server @edgestore/react zod

Environment Variables​

Then go to your Dashboard, create a new project and copy the keys to your environment variables.

.env
shell
EDGE_STORE_ACCESS_KEY=your-access-key
EDGE_STORE_SECRET_KEY=your-secret-key
caution

Make sure you add .env to your .gitignore file.
You don't want to commit your secrets keys to your repository.

Backend​

Now we can create the backend code for our Next.js app.
EdgeStore is compatible with both types of Next.js apps (pages router and app router).

The example below is the simplest bucket you can create with EdgeStore. Just a simple file bucket with no validation that will be accessible by anyone with the link.

You can have multiple buckets in your app, each with its own configuration.

src/app/api/edgestore/[...edgestore]/route.ts
ts
import { initEdgeStore } from '@edgestore/server';
import { createEdgeStoreNextHandler } from '@edgestore/server/adapters/next/app';
 
const es = initEdgeStore.create();
 
/**
 * This is the main router for the EdgeStore buckets.
 */
const edgeStoreRouter = es.router({
  publicFiles: es.fileBucket(),
});
 
const handler = createEdgeStoreNextHandler({
  router: edgeStoreRouter,
});
 
export { handler as GET, handler as POST };
 
/**
 * This type is used to create the type-safe client for the frontend.
 */
export type EdgeStoreRouter = typeof edgeStoreRouter;

Frontend​

Now let's initiate our context provider.

src/lib/edgestore.ts
tsx
'use client';
 
import { type EdgeStoreRouter } from '../app/api/edgestore/[...edgestore]/route';
import { createEdgeStoreProvider } from '@edgestore/react';
 
const { EdgeStoreProvider, useEdgeStore } =
  createEdgeStoreProvider<EdgeStoreRouter>();
 
export { EdgeStoreProvider, useEdgeStore };

And then wrap our app with the provider.

src/app/layout.tsx
tsx
import { EdgeStoreProvider } from '../lib/edgestore';
import './globals.css';
// ...
export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en">
      <body>
        <EdgeStoreProvider>{children}</EdgeStoreProvider>
      </body>
    </html>
  );
}

Upload file​

You can use the useEdgeStore hook to access type-safe frontend client and use it to upload files.

tsx
'use client';
 
import * as React from 'react';
import { useEdgeStore } from '../lib/edgestore';
 
export default function Page() {
  const [file, setFile] = React.useState<File>();
  const { edgestore } = useEdgeStore();
 
  return (
    <div>
      <input
        type="file"
        onChange={(e) => {
          setFile(e.target.files?.[0]);
        }}
      />
      <button
        onClick={async () => {
          if (file) {
            const res = await edgestore.publicFiles.upload({
              file,
              onProgressChange: (progress) => {
                // you can use this to show a progress bar
                console.log(progress);
              },
            });
            // you can run some server action or api here
            // to add the necessary data to your database
            console.log(res);
                        
const res: {
    url: string;
    size: number;
    uploadedAt: Date;
    metadata: Record<string, never>;
    path: Record<string, never>;
    pathOrder: string[];
}
          }
        }}
      >
        Upload
      </button>
    </div>
  );
}

Replace file​

By passing the replaceTargetUrl option, you can replace an existing file with a new one. It will automatically delete the old file after the upload is complete.

You can also just upload the file using the same file name, but in that case, you might still see the old file for a while because of the CDN cache.

tsx
const res = await edgestore.publicFiles.upload({
  file,
  options: {
    replaceTargetUrl: oldFileUrl,
  },
  // ...
});

Delete file​

You can delete a file by passing its url to the delete method.

To be able to delete a file from a client component like this, you will need to set the beforeDelete lifecycle hook on the bucket.

tsx
await edgestore.publicFiles.delete({
  url: urlToDelete,
});

Cancel upload​

To cancel an ongoing file upload, you can use an AbortController the same way you would use it to cancel a fetch request.

tsx
// prepare a state for the AbortController
const [abortController, setAbortController] = useState<AbortController>();
// ...
// instantiate the AbortController and add the signal to the upload method
const abortController = new AbortController();
setAbortController(abortController);
const res = await edgestore.publicFiles.upload({
  file,
  signal: abortController.signal,
});
// ...
// to cancel the upload, call the controller's abort method
abortController?.abort();
info

When you cancel an upload, an UploadAbortedError will be thrown.
You can catch this error and handle it as needed.
For more information, check the Error Handling page.

Temporary files​

You can upload temporary files by passing the temporary option to the upload method. Temporary files will be automatically deleted after 24 hours if they are not confirmed.

tsx
await edgestore.publicFiles.upload({
  file: fileToUpload,
  options: {
    temporary: true,
  },
});

To confirm a temporary file, you can use the confirmUpload method.

tsx
await edgestore.publicFiles.confirmUpload({
  url: urlToConfirm,
});
info

You can check if a file is temporary in the dashboard.
Temporary files are marked with a clock icon.

Troubleshooting​

If you have any problems using EdgeStore, please check the Troubleshooting page.