Advanced

Partial Builds

If you have installed the library via NPM, you can optionally import only the parts of the library you need, which will reduce the size of your bundle and improve load times.

Path	Exports
flipnote.js	All exports
flipnote.js/webcomponent	All exports, plus the Web Components
flipnote.js/PpmParser	PpmParser
flipnote.js/KwzParser	KwzParser
flipnote.js/Player	Player
flipnote.js/playlist	PpmPlaylist, KwzPlaylist
flipnote.js/filename	All exports from filename
flipnote.js/id	All exports from id
flipnote.js/renderers	WebGlCanvas, Html5Canvas, UniversalCanvas

Typescript

Flipnote.js exports comprehensive type definitions for Typescript, which will be included automatically when you import the library from NPM.

Using Typescript isn’t necessary, but it is highly recommended if you are using flipnote.js for any critical infrastructure such as Flipnote conversion services, since it will help you catch type errors at compile time rather than when your code is running.

In some cases, you may want to use types separately from the core library. For example, if you wanted to only import the Flipnote and FlipnoteFormat types, you could do:

import type { Flipnote, FlipnoteFormat } from 'flipnote.js';

// Then you can use these as Typescript types like:
const note: Flipnote;

// load a note...

if (note.format === FlipnoteFormat.KWZ) {
  // only run this code if the note is a KWZ...
}