Aller au contenu principal

UploadFile

Ensemble de méthodes permettant de manipuler les fichiers importés dans l'application.

Types​

type TFile = {
  name: string;
  mimeType: string;
  uri: string;
};

Références​

const isFilesOverLimit: (files?: File[], maxSize?: number) => boolean;
const formatSize: (bytes: number) => string;
const uploadFile: (file: File) => Promise<TFile>;

isFilesOverLimit​

Permets de vérifier que la taille des fichiers est inférieure à une limite autorisée.

astuce

La taille d'un fichier est en octets. La limite par défaut est de 10Mo.

Paramètres​

  • files
    • Requis
    • Tableau de fichiers (Exemple : files:[file1, file2]).
  • limit
    • Limite de taille (Exemple : limit: 10000000).

Exemple​

import { isFilesOverLimit } from '@creatic/reactic-utils';

const files = [
  { name: 'file1', size: 1000000 },
  { name: 'file2', size: 1000000 },
  { name: 'file3', size: 1000000 },
];

isFilesOverLimit(files); // false

isFilesOverLimit(files, 2000000); // true

formatSize​

Permets de récupérer la taille d'un fichier, sous forme de chaîne de caractères.

L'unité de mesure est automatiquement déterminée. Cette unité peut avoir les valeurs suivantes : n/a, octets, Ko, Mo, Go, To.

Paramètres​

  • bytes
    • Requis
    • Taille du fichier (Exemple : bytes: 1000000).

Exemple​

import { formatSize } from '@creatic/reactic-utils';

formatSize(1e6); // '1 Mo'
formatSize(1e9); // '1 Go'

uploadFile​

Permets de transformer un fichier en une donnée API.

Paramètres​

  • file
    • Requis
    • Fichier à transformer (Exemple : file).

Exemple​

import { uploadFile } from '@creatic/reactic-utils';

const file = new File(['Hello, world!'], 'hello.txt', { type: 'text/plain' });

const uploadedFile = await uploadFile(file);

console.log(uploadedFile); // { name: 'hello.txt', mimeType: 'text/plain', uri: 'data:text/plain;base64,SGVsbG8sIHdvcmxkIQ==' }