feat: update some related names

Author: refinist

README.md

@@ -1,6 +1,6 @@
 # vue-amap [![npm](https://img.shields.io/npm/v/@refinist/vue-amap.svg?style=flat&colorA=2b99ff&colorB=387aff)](https://npmjs.com/package/@refinist/vue-amap)
 
-Using Vue3 component to use AMap
+Using Vue3 component to use Amap
 
 ## Features
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@refinist/vue-amap",
   "version": "0.0.2",
-  "description": "Using Vue3 component to use AMap",
+  "description": "Using Vue3 component to use Amap",
   "keywords": [
     "vue",
     "amap",

playground/src/App.vue

@@ -8,7 +8,7 @@ onMounted(() => {
   console.log('amapRef :>> ', amapRef.value);
 });
 
-const { amapInit, getAmap, amapStatus, amapStatusChange, whenAMapReady } =
+const { amapInit, getAmap, amapStatus, amapStatusChange, whenAmapReady } =
   useAmap();
 
 watchEffect(() => {
@@ -35,8 +35,8 @@ const handleError = e => {};
 // Test the edge case of operating the map before it is fully loaded
 let marker;
 const handleOperateMapBeforeLoadedMaybe = async () => {
-  // whenAMapReady Usage 1
-  // whenAMapReady(({ map, AMap }) => {
+  // whenAmapReady Usage 1
+  // whenAmapReady(({ map, AMap }) => {
   //   if (!marker) {
   //     marker = new AMap.Marker({
   //       icon: '//a.amap.com/jsapi_demos/static/demo-center/icons/poi-marker-default.png',
@@ -47,8 +47,8 @@ const handleOperateMapBeforeLoadedMaybe = async () => {
   //   }
   // });
 
-  // whenAMapReady Usage 2
-  const { map, AMap } = await whenAMapReady();
+  // whenAmapReady Usage 2
+  const { map, AMap } = await whenAmapReady();
   if (!marker) {
     marker = new AMap.Marker({
       icon: '//a.amap.com/jsapi_demos/static/demo-center/icons/poi-marker-default.png',

src/Amap.vue

@@ -2,7 +2,7 @@
 import { computed, onMounted, onUnmounted, ref } from 'vue';
 import AMapLoader from '@amap/amap-jsapi-loader';
 import { defaultOptions } from './defaultOptions';
-import { sleep, toCssUnit } from './utils';
+import { toCssUnit } from './utils';
 import type { Status, Map, AMap } from './types';
 
 defineOptions({

src/types.ts

@@ -6,7 +6,7 @@ export type Map = Record<string, any>;
 
 export type AMap = Record<string, any>;
 
-export type Instance = {
+export type MapInstance = {
   map: Map;
   AMap: AMap;
 };

src/useAmap.ts

@@ -1,5 +1,5 @@
 import { ref, shallowRef, watch } from 'vue';
-import type { Map, AMap, Status, Instance } from './types';
+import type { Map, AMap, Status, MapInstance } from './types';
 
 export const useAmap = () => {
   const status = ref<Status>('loading');
@@ -11,7 +11,7 @@ export const useAmap = () => {
     map: null
   });
 
-  const init = (e: Instance) => {
+  const init = (e: MapInstance) => {
     instance.value = e;
   };
   const statusChange = (p: Status) => {
@@ -23,11 +23,11 @@ export const useAmap = () => {
 
   // Ensure operations are performed after the map is ready.
   // Can be executed independently of handleComplete to accommodate more business scenarios.
-  const whenAMapReady = (
-    cb?: (instance: Instance) => void
-  ): Promise<Instance> => {
-    let resolve!: (value: Instance) => void;
-    const p = new Promise<Instance>(_ => (resolve = _));
+  const whenAmapReady = (
+    cb?: (instance: MapInstance) => void
+  ): Promise<MapInstance> => {
+    let resolve!: (value: MapInstance) => void;
+    const p = new Promise<MapInstance>(_ => (resolve = _));
 
     const { map, AMap } = get();
     if (map && AMap) {
@@ -69,6 +69,6 @@ export const useAmap = () => {
     amapStatusChange: statusChange,
     getAmap: get,
     amapStatus: status,
-    whenAMapReady
+    whenAmapReady
   };
 };