Websites v4 docs v8.3.1
    Preparing search index...

    Class Font

    Uploads font files to S3 via the Images API, which also records them in the Homeflow DB fonts table for queryability. The agency's global config remains the source of truth for which fonts a site uses and how they are rendered.

    Hierarchy

    • default<null, null, null>
      • Font
    Index

    Properties

    serializer

    Methods

    get toJSON create

    Properties

    serializer: (model: any) => any

    serializer is a pure function that takes a model instance and returns a plain object that describes how to convert the model to JSON

    Methods

    • Retrieves a value from raw API data. Prioritises DBAPI data if available

      Parameters

      • key: string

      Returns any

    • Special method to define behaviour of JSON.stringify() on model instance

      Returns any

    • Parameters

      • __namedParameters: {
            data: string | null;
            familyName?: string;
            filename: string | null;
            siteId: number | null;
            style?: string;
            weight?: number;
        }

      Returns Promise<
          | {
              errors: { message: { status: number } }[]
              | null;
              result: { path: string; url: string } | null;
          }
          | null,
      >

      const res = await Font.create({ filename, data, siteId: agency.siteId });

      Font creation requires a Bearer token (app verification) via production users api, regardless of environment. This is handled in the images-api-client/index.ts

    Settings

    Member Visibility

    On This Page

    Properties
    Methods