@4-us-4-others/are.na 中文文档教程

Question

are.na API wrapper for JavaScript

使用 Axios，它基于 Promise 并与 Node.js/io.js 或现代浏览器兼容。 在服务器端或在 React、Vue 或 Angular 应用程序中使用它。

What is this fork?

这个 repo 是我们对 @ivangreene 的 arena-js ↗ 的分支。

目前，我们发布它是为了提供一些对依赖漏洞的快速修复，并且可能会推送一些小的更新。

⚠️ Experimental — 不要使用这个！

Installation

可从 npm 获得：

$ npm install are.na

# or:

$ yarn add are.na

Example

const Arena = require('are.na');

const arena = new Arena();

arena.channel('arena-influences').get()
  .then(chan => {
    chan.contents.map(item => {
      console.log(item.title);
    });
  })
  .catch(err => console.log(err));

Usage

该类按层次结构组织为嵌套对象。 模拟 are.na api 文档 结构。

- new Arena([config])

• Config can optionally be passed as an object:
  • accessToken: Your are.na API access token
  • baseURL: Base URL to make requests on (default: https://api.are.na/v2/)

Example:

let arena = new Arena({ accessToken: 'abcd' });

使用数组解析的方法将具有一个包含返回的其他数据的 attrs 属性。 例如，channel(slug).connections() 将解析为通道块连接的数组，以及包含 lengthattrs 属性>、total_pages、current_page 等。

一些方法可以使用分页。 将 params 作为对象传递，格式为 { page: 3, per: 10 }。

channel([slug || id][, params])

Method	Returns	Description
.get([params])	Promise<Object>	Get the channel as an Object. Gets a list of public channels if slug/id not specified. Supports pagination.
.thumb([params])	Promise<Object>	Limited view of the channel.
.connections([params])	Promise<Array>	Get all of the connections of the channel (channels where this channel is connected). Supports pagination.
.channels([params])	Promise<Array>	Get all of the channels connected to blocks in the channel. Supports pagination.
.contents([params])	Promise<Array>	Get the channel's contents only, as an array. Supports pagination.
.collaborators([params])	Promise<Array>	Get the channel's collaborators. Supports pagination.
.create([title || status][, status])	Promise<Object>	Creates a new channel. Can be called as channel(title).create([status]) or channel().create(title[, status]). Title is required, status is optional.
.delete([slug])	Promise	Delete the channel. Can be called as channel(slug).delete() or channel().delete(slug).
.update(params)	Promise<Object>	Update the channel's attributes. params should be an object and can include title and/or status. Currently it appears that the are.na API requires both values. If title is not set, an error will occur. If status is not set, it will default to "public".
.addCollaborators(...userIds)	Promise<Array>	Add collaborators to a channel. Pass userIds as an Array or multiple arguments. channel(slug).addCollaborators(123, 456) or channel(slug).addCollaborators([123, 456]) works.
.deleteCollaborators(...userIds)	Promise<Array>	Remove collaborators from a channel. Accepts userIds in the same format as addCollaborators.
.createBlock(content||source)	Promise<Object>	Create a block and add it to the channel. Specify textual content or a source link.
.deleteBlock(blockId)	Promise	Remove a block from the channel.

Example:

// Get first 3 pieces of content from a channel and print their titles
arena.channel('arena-influences').contents({ page: 1, per: 3 })
  .then(contents => {
    contents.map(content => {
      console.log(content.title);
    });
  })
  .catch(err => console.log(err));

// Create a new channel called "beautiful foods" that is closed
arena.channel('beautiful foods').create('closed');
// or
arena.channel().create('beautiful foods', 'closed')
  .then(chan => console.log('Slug: ' + chan.slug))
  .catch(err => console.log(err));

block([id][, params])

Method	Returns	Description
.get([params])	Promise<Object>	Get the block specified by id.
.channels([params])	Promise<Array>	Get a list of the channels a block belongs to.
.create(channelSlug, content || source)	Promise<Object>	Create a block and add it to the channel. Specify textual content or a source link.
.update({ content, title, description })	Promise	Update a block. Pass an object with one or more of content, title or description fields to update those fields.

Example:

// Get a block, print its title
arena.block(8693).get()
  .then(block => console.log(block.title))
  .catch(console.error);

// Create a block in the channel 'great-websites'
arena.block().create('great-websites', 'https://are.na/');

// Update a block
arena.block('65234').update({ content: 'New content', title: 'New title', description: 'New description' });

user(id || slug[, params])

Method	Returns	Description
.get([params])	Promise<Object>	Get a user specified by id.
.channels([params])	Promise<Array>	Get a user's channels, as an array. Supports pagination.
.following([params])	Promise<Array>	Get a list of users and/or blocks the user is following. Supports pagination.
.followers([params])	Promise<Array>	Get a list of the user's followers. Supports pagination.

Example:

// Get a user, print their name
arena.user(23484).get().then(user => console.log(user.full_name));

search(query[, params])

所有方法都支持分页。

Method	Returns	Description
.all([params])	Promise<Object>	Search for channels, blocks, and users matching query. (The API currently only seems to return channels and blocks, and the users array will be empty?)
.users([params])	Promise<Array>	Search for users.
.channels([params])	Promise<Array>	Search for channels.
.blocks([params])	Promise<Array>	Search for blocks.

Example:

// Get the 2nd page of 3 channel results for 'art',
// print links to them
arena.search('art').channels({ page: 2, per: 3})
  .then(channels => {
    channels.map(chan => {
      console.log('https://www.are.na/channels/' + chan.slug);
    });
  });

Testing

为了运行测试，您必须添加一个 are.na Personal Access Token 作为 shell 变量（在运行 $ yarn test 时传递）。

1. Create an new app at dev.are.na ↗, and get your Personal Access Token.
2. Add your Personal Access Token to your shell config (~/.bash_profile, .zshrc, etc) ⤵

   export ARENA_ACCESS_TOKEN="YOUR_PERSONAL_ACCESS_TOKEN"