Skip to content

Axios Plugin Documentation is Broken #1694

@pwfraley

Description

@pwfraley

Environment

Quasar 2.12.2
JavaScript
Pinia
Pinia-Orm
Pinia-Orm/axios

Reproduction

Follow the Documentation from the Plugin, to Configure Axios and Create an Axios Repository you are supposed to import:

import { createPiniaOrmPluginAxios } from "@pinia-orm/axios";

this results in the following waring in the quasar console:

export 'createPiniaOrmPluginAxios' (imported as 'createPiniaOrmPluginAxios') was not found in '@pinia-orm/axios' (possible exports: AxiosRepository, Request, Response, createPiniaOrmAxios, piniaOrmPluginAxios, useAxiosApi, useAxiosRepo)

Seems like the createPiniaOrmPluginAxios does not exist.

Describe the bug

The documentation is wrong, or the package is wrong, either way, following the documentation results in errors.

Additional context

Also the documentation is very very very basic. There are no examples on how to create a repository, when to use useRepo or useAxios repo, there is no example on creating a repo (should it inherit from Repository from pinia-orm or should it inherit from AxiosRepository?

Please update the documentation and also maybe include a standard example for a vue app using Pinia/Pinia-Orm and the Pinia-ORM/Axios plugin, I think this would help new Users on how to use Pinia-ORM with axios.

Logs

export 'createPiniaOrmPluginAxios' (imported as 'createPiniaOrmPluginAxios') was not found in '@pinia-orm/axios' (possible exports: AxiosRepository, Request, Response, createPiniaOrmAxios, piniaOrmPluginAxios, useAxiosApi, useAxiosRepo)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationduplicateThis issue or pull request already exists

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions