Fetch List of Beams

Fetching a list of beams is quite similar to what we did with fetching a beam with its id in the previous tutorial, only that we do not to specify any id. It involves querying the underlying beam model using GraphQL API through the SDK's GQL service.

1. Let's start again by creating a new file

touch fetch-beam-list.ts

2. Open this new file, import the SDK package and assign the graphQL client (from SDK services) to a variable

fetch-beam-list.ts

import getSDK from "@akashaorg/awf-sdk";

const gqlClient = getSDK().services.gql.client;

3. Let's define a function to handle and return the response from the SDK service.

fetch-beam-list.ts

import getSDK from "@akashaorg/awf-sdk";

const gqlClient = getSDK().services.gql.client;

const fetchBeamsHandler = async () => {
  try {
    const response = await gqlClient.GetBeams({});
  } catch (error) {
    console.log(`An error occured: ${error.message}`);
  }
};

4. We need to provide some parameters to the GetBeams method from the gqlClient. These parameters could be

• first: to get a part of the beams from the start of the list (eg: { first: 10 })
• last: to get a part of the beams from the end of the list (eg: { last: 5 })
• before: to get the beams before that specifed cursor position
• after: to get the beams after that specifed cursor position
• filters: to filter beams (eg: get beams where the authorId match a given value)
• sorting: to sort the list (eg: get beams sorted in ascending chronological order)

Let's get the first 10 beams, sorted in a descending chronological order

fetch-beam-list.ts

import getSDK from "@akashaorg/awf-sdk";

const gqlClient = getSDK().services.gql.client;

const fetchBeamsHandler = async () => {
  try {
    const response = await gqlClient.GetBeams({});
    const response = await gqlClient.GetBeams({
      first: 10,
      sorting: "DESC",
    });

    console.log(response.data);
  } catch (error) {
    console.log(`An error occured: ${error.message}`);
  }
};

1. We can now run the function

fetch-beam-list.ts

import getSDK from "@akashaorg/awf-sdk";

const gqlClient = getSDK().services.gql.client;

const fetchBeamsHandler = async () => {
  try {
    const response = await gqlClient.GetBeams({
      first: 10,
      sorting: "DESC",
    });

    // the list of beams is contained in a node
    console.log(response.data?.akashaBeamIndex?.edges[0].node);
  } catch (error) {
    console.log(`An error occured: ${error.message}`);
  }
};

fetchBeamsHandler();

Congratulations! We have successfully fetched a list of beams. Feel free to by tweak the optional parameters in the GetBeams method and compare the variations in the list of beams returned