Skip to main content

js_library

Function Signature​

def js_library(
    *,
    name: str,
    default_target_platform: None | str = None,
    target_compatible_with: list[str] = [],
    compatible_with: list[str] = [],
    exec_compatible_with: list[str] = [],
    visibility: list[str] = [],
    within_view: list[str] = ["PUBLIC"],
    metadata: OpaqueMetadata = {},
    tests: list[str] = [],
    modifiers: OpaqueMetadata = [],
    _apple_platforms: dict[str, str] = {},
    _asset_dest_path_resolver: None | str = select({"gh_facebook_buck2_shims_meta//tools/build_defs/js/config:asset_dest_path_resolver_android": "android", "gh_facebook_buck2_shims_meta//tools/build_defs/js/config:asset_dest_path_resolver_generic": "generic", "DEFAULT": None}),
    _is_release: bool = select({"prelude//runtime:fbcode": select({"prelude//build_mode/constraints:opt": True, "DEFAULT": False}), "DEFAULT": select({"prelude//build_mode/constraints:release": True, "DEFAULT": select({"gh_facebook_buck2_shims_meta//tools/build_defs/android/config:build_mode_opt": True, "DEFAULT": False})})}),
    _platform: str = select({"prelude//react-native:macos": "macos", "gh_facebook_buck2_shims_meta//tools/build_defs/js/constraints/metro_js_platform_override:android": "android", "gh_facebook_buck2_shims_meta//tools/build_defs/js/constraints/metro_js_platform_override:ios": "ios", "gh_facebook_buck2_shims_meta//tools/build_defs/js/constraints/metro_js_platform_override:macos": "macos", "gh_facebook_buck2_shims_meta//tools/build_defs/js/constraints/metro_js_platform_override:vr": "vr", "gh_facebook_buck2_shims_meta//tools/build_defs/js/constraints/metro_js_platform_override:windows": "windows", "DEFAULT": select({"prelude//os/constraints:iphoneos": "ios", "prelude//os/constraints:windows": "windows", "DEFAULT": "android"})}),
    asset_extensions: None | list[str] = None,
    asset_platforms: None | list[str] = None,
    base_path: None | str = None,
    contacts: list[str] = [],
    default_host_platform: None | str = None,
    deps: list[str] = [],
    deps_query: None | str = None,
    extra_json: None | str = None,
    labels: list[str] = [],
    licenses: list[str] = [],
    srcs: list[str | (str, str)] = [],
    worker: str,
) -> None

Parameters​

  • name: (required)

    name of the target

  • default_target_platform: (defaults to: None)

    specifies the default target platform, used when no platforms are specified on the command line

  • target_compatible_with: (defaults to: [])

    a list of constraints that are required to be satisfied for this target to be compatible with a configuration

  • compatible_with: (defaults to: [])

    a list of constraints that are required to be satisfied for this target to be compatible with a configuration

  • exec_compatible_with: (defaults to: [])

    a list of constraints that are required to be satisfied for this target to be compatible with an execution platform

  • visibility: (defaults to: [])

    a list of visibility patterns restricting what targets can depend on this one

  • within_view: (defaults to: ["PUBLIC"])

    a list of visibility patterns restricting what this target can depend on

  • metadata: (defaults to: {})

    a key-value map of metadata associated with this target

  • tests: (defaults to: [])

    a list of targets that provide tests for this one

  • modifiers: (defaults to: [])

    an array of modifiers associated with this target