В этом руководстве показано, как открыть карту Google, используя заданный набор координат. Эти координаты берутся из набора результатов, который вы получаете после выполнения запроса в TeamSQL.
Предпосылки
Прежде чем начать, необходимо установить:
- TeamSQL: у вас также должна быть учетная запись TeamSQL, которую вы используете для входа в свою учетную запись TeamSQL. Если у вас ее еще нет, вам будет предложено создать учетную запись при первом входе. запустить TeamSQL
- Node.js: Node.js поставляется с npm, но, поскольку последний обновляется чаще, вам нужно убедиться, что вы используете самую последнюю версию версия
- TypeScript
Установите интерфейс командной строки TeamSQL
Вы можете установить TeamSQL CLI, выполнив следующую команду:
npm i -g @teamsqlio/teamsql-cli
Затем вам нужно будет войти в систему, используя свои учетные данные TeamSQL. Начните процесс входа в систему, запустив
teamsql-cli login
Вам будет предложено ввести имя пользователя и пароль. Обязательно используйте тот же набор учетных данных, который вы используете для входа в локальный экземпляр TeamSQL.
Создайте свое расширение
Самый простой способ приступить к созданию расширения — клонировать шаблон Контекстное меню, предоставленный вам в качестве основы.
Перейдите к месту на диске, где вы хотите работать с расширением. Выполните следующую команду, чтобы клонировать шаблон контекстного меню:
teamsql-cli create
Вам будет предложено выбрать шаблон. Если появится Контекстное меню, нажмите Enter (или Return), чтобы начать процесс клонирования extension-context-menu-template
.
Как только вы получите сообщение о том, что процесс клонирования завершен, вы можете начать работу над своим расширением.
Содержимое репозитория 'extension-context-menu-template”
Все папки проекта расширения должны содержать как минимум четыре следующих файла в корне:
- README.MD: [Markdown] файл, содержащий хорошо написанное описание вашего расширения, а также соответствующие изображения, инструкции по использованию и т. д. Если мы одобрим ваше расширение и оно станет доступным в магазине расширений TeamSQL, содержимое этого файла будет использоваться в качестве описания.
- icon.png: значок (512 x 512 пикселей) в формате PNG, который будет использоваться с вашим расширением.
- index.js: основной файл вашего расширения (мы изменим особенности этого файла позже в этом руководстве).
- package.json: файл, содержащий информацию о конфигурации вашего пакета npm.
Написание вашего расширения
Код вашего расширения находится в файле index.js
, который вы позже скомпилируете в TypeScript для установки.
Существует несколько разных классов, позволяющих реализовать функциональные возможности, в которых ваше расширение взаимодействует с данными, доступными в среде TeamSQL, или использует их преимущества. По большей части вам не нужно использовать эти классы без необходимости. Исключением является ваш основной класс, который должен расширять класс Extension и реализовывать один из интерфейсов, доступных через TeamSQL Extension SDK.
export class TeamSQLExtension extends Extension implements IExtensionContextMenu { … … }
Весь код, реализующий функциональность вашего расширения, должен находиться в этом классе. В частности, вот один из способов реализации этого расширения:
Подготовьтесь к установке
Теперь, когда вы создали расширение, вам необходимо выполнить следующие шаги, чтобы подготовить его к установке.
- В корне расширения установите необходимые пакеты npm для этого руководства, запустив
npm install
. - Создайте проект расширения с помощью TypeScript, запустив
tsc -p .
. - На этом этапе вы готовы установить расширение. Вы можете сделать это, выполнив следующую команду:
teamsql-cli submit — install
. Если установка прошла успешно, вы готовы использовать свое расширение!
Используйте расширение
После запуска TeamSQL и подключения к выбранной базе данных вы выполните запрос, в котором возвращаемые данные включают хотя бы один набор координат.