Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • default

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

axios

axios: AxiosInstance

options

options: StrapiOptions

Private state

state: { user: any }

Type declaration

  • user: any

storeConfig

storeConfig: StoreConfig

Accessors

user

  • get user(): Record<string, any>
  • set user(user: Record<string, any>): void

  • Returns Record<string, any>

  • Parameters

    • user: Record<string, any>

    Returns void

Methods

authenticateProvider

  • Authenticate the user with the token present on the URL (for browser) or in params (on Node.js)

    Parameters

    Returns Promise<Authentication>

clearToken

  • clearToken(): void

  • Remove token from Axios configuration

    Returns void

count

  • count(entity: string, params?: any): Promise<object[]>

  • Get the total count of entries with the provided criteria

    Parameters

    • entity: string
    • Optional params: any

      Filter and order queries.

    Returns Promise<object[]>

create

  • create(entity: string, data: any): Promise<object>

  • Create data

    Parameters

    • entity: string

      Type of entry pluralized

    • data: any

      New entry

    Returns Promise<object>

delete

  • delete(entity: string, id: string): Promise<object>

  • Delete an entry

    Parameters

    • entity: string

      Type of entry pluralized

    • id: string

      ID of entry

    Returns Promise<object>

fetchUser

  • fetchUser(): Promise<Record<string, any>>

  • Fetch the user data . user.me

    Returns Promise<Record<string, any>>

find

  • find(entity: string, params?: any): Promise<object[]>

  • List entries

    Parameters

    • entity: string
    • Optional params: any

      Filter and order queries.

    Returns Promise<object[]>

findById

  • findById(entity: string, id: string): Promise<object>

  • Get a specific entry

    Parameters

    • entity: string

      Type of entry pluralized

    • id: string

      ID of entry

    Returns Promise<object>

findFile

  • findFile(id: string): Promise<object>

  • Get file

    Parameters

    • id: string

      ID of entry

    Returns Promise<object>

findFiles

  • findFiles(params?: any): Promise<object[]>

  • Get files

    Parameters

    • Optional params: any

      Filter and order queries

    Returns Promise<object[]>

    Object[] Files data

forgotPassword

getProviderAuthenticationUrl

  • getProviderAuthenticationUrl(provider: Provider): string

  • Retrieve the connect provider URL

    Parameters

    Returns string

getToken

  • getToken(): string

  • Returns string

graphql

  • qyery data graphql

    Parameters

    Returns Promise<object[]>

Private isBrowser

  • isBrowser(): boolean

  • Check if it runs on browser

    Returns boolean

login

  • Login by getting an authentication token.

    Parameters

    Returns Promise<Authentication>

    Authentication User token and profile

logout

  • logout(): void

  • Returns void

register

request

  • request(method: Method, url: string, requestConfig?: AxiosRequestConfig): Promise<any>

  • Axios request

    Parameters

    • method: Method

      Request method

    • url: string

      Server URL

    • Optional requestConfig: AxiosRequestConfig

      Custom Axios config

    Returns Promise<any>

resetPassword

searchFiles

  • searchFiles(query: string): Promise<object[]>

  • Search for files

    Parameters

    • query: string

      Keywords

    Returns Promise<object[]>

setToken

  • setToken(token: string, comesFromStorage?: boolean): void

  • Set token on Axios configuration

    Parameters

    • token: string

      Retrieved by register or login

    • Optional comesFromStorage: boolean

    Returns void

setUser

  • setUser(user: any): Promise<void>

  • Parameters

    • user: any

    Returns Promise<void>

Private syncToken

  • syncToken(jwt?: string): string

  • Parameters

    • Optional jwt: string

    Returns string

update

  • update(entity: string, id: string, data: any): Promise<object>

  • Update data

    Parameters

    • entity: string

      Type of entry pluralized

    • id: string

      ID of entry

    • data: any

    Returns Promise<object>

upload

  • upload(data: FormData, requestConfig?: AxiosRequestConfig): Promise<object>

  • Upload files

    Browser example

     
    const form = new FormData();
form.append('files', fileInputElement.files[0], 'file-name.ext');
form.append('files', fileInputElement.files[1], 'file-2-name.ext');
const files = await strapi.upload(form);

    Node.js example

     
    const FormData = require('form-data');
const fs = require('fs');
const form = new FormData();
form.append('files', fs.createReadStream('./file-name.ext'), 'file-name.ext');
const files = await strapi.upload(form, {
  headers: form.getHeaders()
});

    Parameters

    • data: FormData

      FormData

    • Optional requestConfig: AxiosRequestConfig

    Returns Promise<object>

Generated using TypeDoc